Skip to content

Commit 354d989

Browse files
committed
docs: guidelines for students and teachers (#23648)
Short summary: contributing code you wrote for a class is fine, just don't make the contribution process part of a class.
1 parent f76a85e commit 354d989

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ attention.
1111
- If submitting code, have you built your formula locally prior to submission with `gradle check`?
1212
- If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
1313
- If submitting code, have you checked that your submission is for an [OS that we support](https://www.elastic.co/support/matrix#show_os)?
14+
- If you are submitting this code for a class then read our [policy](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md#contributing-as-part-of-a-class) for that.

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,3 +138,32 @@ Before submitting your changes, run the test suite to make sure that nothing is
138138
```sh
139139
gradle check
140140
```
141+
142+
Contributing as part of a class
143+
-------------------------------
144+
In general Elasticsearch is happy to accept contributions that were created as
145+
part of a class but strongly advise against making the contribution as part of
146+
the class. So if you have code you wrote for a class feel free to submit it.
147+
148+
Please, please, please do not assign contributing to Elasticsearch as part of a
149+
class. If you really want to assign writing code for Elasticsearch as an
150+
assignment then the code contributions should be made to your private clone and
151+
opening PRs against the primary Elasticsearch clone must be optional, fully
152+
voluntary, not for a grade, and without any deadlines.
153+
154+
Because:
155+
156+
* While the code review process is likely very educational, it can take wildly
157+
varying amounts of time depending on who is available, where the change is, and
158+
how deep the change is. There is no way to predict how long it will take unless
159+
we rush.
160+
* We do not rush reviews without a very, very good reason. Class deadlines
161+
aren't a good enough reason for us to rush reviews.
162+
* We deeply discourage opening a PR you don't intend to work through the entire
163+
code review process because it wastes our time.
164+
* We don't have the capacity to absorb an entire class full of new contributors,
165+
especially when they are unlikely to become long time contributors.
166+
167+
Finally, we require that you run `gradle check` before submitting a
168+
non-documentation contribution. This is mentioned above, but it is worth
169+
repeating in this section because it has come up in this context.

0 commit comments

Comments
 (0)