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.
This commit is contained in:
parent
d010cad503
commit
7b4c5fe29f
|
@ -11,3 +11,4 @@ attention.
|
|||
- If submitting code, have you built your formula locally prior to submission with `gradle check`?
|
||||
- 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.
|
||||
- If submitting code, have you checked that your submission is for an [OS that we support](https://www.elastic.co/support/matrix#show_os)?
|
||||
- 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.
|
||||
|
|
|
@ -139,3 +139,32 @@ Before submitting your changes, run the test suite to make sure that nothing is
|
|||
```sh
|
||||
gradle check
|
||||
```
|
||||
|
||||
Contributing as part of a class
|
||||
-------------------------------
|
||||
In general Elasticsearch is happy to accept contributions that were created as
|
||||
part of a class but strongly advise against making the contribution as part of
|
||||
the class. So if you have code you wrote for a class feel free to submit it.
|
||||
|
||||
Please, please, please do not assign contributing to Elasticsearch as part of a
|
||||
class. If you really want to assign writing code for Elasticsearch as an
|
||||
assignment then the code contributions should be made to your private clone and
|
||||
opening PRs against the primary Elasticsearch clone must be optional, fully
|
||||
voluntary, not for a grade, and without any deadlines.
|
||||
|
||||
Because:
|
||||
|
||||
* While the code review process is likely very educational, it can take wildly
|
||||
varying amounts of time depending on who is available, where the change is, and
|
||||
how deep the change is. There is no way to predict how long it will take unless
|
||||
we rush.
|
||||
* We do not rush reviews without a very, very good reason. Class deadlines
|
||||
aren't a good enough reason for us to rush reviews.
|
||||
* We deeply discourage opening a PR you don't intend to work through the entire
|
||||
code review process because it wastes our time.
|
||||
* We don't have the capacity to absorb an entire class full of new contributors,
|
||||
especially when they are unlikely to become long time contributors.
|
||||
|
||||
Finally, we require that you run `gradle check` before submitting a
|
||||
non-documentation contribution. This is mentioned above, but it is worth
|
||||
repeating in this section because it has come up in this context.
|
||||
|
|
Loading…
Reference in New Issue