Skip to content

Commit

Permalink
Update contributing README (#7278)
Browse files Browse the repository at this point in the history
Co-authored-by: Cee Chen <[email protected]>
  • Loading branch information
JasonStoltz and cee-chen authored Oct 12, 2023
1 parent d8d4a3a commit 3af30c6
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions wiki/contributing-to-eui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ If there isn't an associated feature request or bug report in EUI's backlog yet,

## Process

### How we assign work and define our roadmap
### Who can contribute?

EUI is built primarily by employees of Elastic. We try to do this in the open as much as possible, but do utilize closed meetings and other planning tools to dictate our longer term roadmap. We try to transcribe the decisions from these discussions in the form of specifications to Github issues for transparency. In general, once on Github, any issue can be worked on by the community. We usually reserve larger projects or ones that are core to our roadmap or design to be done internally. In these cases we mark these issues as `assigned` to a person using Github. We do not, as a policy, assign issues to community members. If you find an issue that is not assigned, assume that you are welcome to work on it and can submit a pull request. Feel free to leave a comment to mark intent and avoid conflict.
EUI is built primarily by and for employees of Elastic. We align our features and roadmap with the needs of our products internally.

While EUI's primary customer is Kibana and other Elastic products, open source is a part of our DNA at Elastic, and commmunity contributions from outside of Elastic are welcome. These contributions are typically reviewed and merged on a best-effort basis and must generally align with the overall objectives of this project.

In general, once on Github, any issue can be worked on by the community. If you find an issue that is not assigned, assume that you are welcome to work on it and can submit a pull request. We recommend that you leave us a comment indicating your intent before starting work to avoid potential conflict. We do not, as a policy, assign issues to community members and we usually reserve larger projects or ones that are core to our roadmap or design to be done internally.

Our best PRs tend to come from existing users whom have a challenge they are attempting to overcome and wish to help us solve it. If you are new to open source and looking for a good project to start making contributions, this project may not be a good fit. We have an extensive backlog in which you'll likely encounter outdated issues and issues lacking the appropriate context to get started.

### How to ensure the timely review of pull requests

Expand Down

0 comments on commit 3af30c6

Please sign in to comment.