honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-22 21:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Updated CONTRIBUTING.md to provide more details about the PR process

Browse Source 
Closes #6323
This commit is contained in:
Clinton Gormley 2014-06-12 13:07:04 +02:00
parent 1b45b216fd
commit be2b8066d1
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -42,7 +42,7 @@ The process for contributing to any of the [Elasticsearch repositories](https://
### Fork and clone the repository ### Fork and clone the repository
You will need to fork the main Elasticsearch code or documentation repository and clone it to your local machine. See You will need to fork the main Elasticsearch code or documentation repository and clone it to your local machine. See
[github help page](https://help.github.com/articles/fork-a-repo) for help. [github help page](https://help.github.com/articles/fork-a-repo) for help.
Further instructions for specific projects are given below. Further instructions for specific projects are given below.
@ -62,15 +62,15 @@ Once your changes and tests are ready to submit for review:
3. Rebase your changes 3. Rebase your changes
Update your local repository with the most recent code from the main Elasticsearch repository, and rebase your branch on top of the latest master branch. We prefer your changes to be squashed into a single commit. Update your local repository with the most recent code from the main Elasticsearch repository, and rebase your branch on top of the latest master branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review. As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.
4. Submit a pull request 4. Submit a pull request
Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/using-pull-requests). In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg "Closes #123". Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/using-pull-requests). In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, eg "Closes #123".
Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into Elasticsearch. Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into Elasticsearch.
Contributing to the Elasticsearch codebase Contributing to the Elasticsearch codebase
------------------------------------------ ------------------------------------------