Skip to content

Commit be2b806

Browse files
Docs: Updated CONTRIBUTING.md to provide more details about the PR process
Closes #6323
1 parent 1b45b21 commit be2b806

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The process for contributing to any of the [Elasticsearch repositories](https://
4242

4343
### Fork and clone the repository
4444

45-
You will need to fork the main Elasticsearch code or documentation repository and clone it to your local machine. See
45+
You will need to fork the main Elasticsearch code or documentation repository and clone it to your local machine. See
4646
[github help page](https://help.github.com/articles/fork-a-repo) for help.
4747

4848
Further instructions for specific projects are given below.
@@ -62,15 +62,15 @@ Once your changes and tests are ready to submit for review:
6262

6363
3. Rebase your changes
6464

65-
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.
65+
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.
66+
6667

6768
4. Submit a pull request
6869

69-
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".
70+
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".
7071

7172
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.
7273

73-
7474
Contributing to the Elasticsearch codebase
7575
------------------------------------------
7676

0 commit comments

Comments
 (0)