You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/project-docs/contributing.md
+14-1
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,19 @@ Pull Requests
26
26
***DO** refer to any relevant issues, and include [keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) that automatically close issues when the PR is merged.
27
27
***DO** tag any users that should know about and/or review the change.
28
28
***DO** ensure each commit successfully builds. The entire PR must pass all tests in the Continuous Integration (CI) system before it'll be merged.
29
-
***DO** address PR feedback in an additional commit(s) rather than ammending the existing commits, and only rebase/squash them when necessary. This makes it easier for reviewers to track changes. If necessary, squashing should be handled by the merger using the ["squash and merge"](https://github.com/blog/2141-squash-your-commits) feature, and should only be done by the contributor upon request.
29
+
***DO** address PR feedback in an additional commit(s) rather than amending the existing commits, and only rebase/squash them when necessary. This makes it easier for reviewers to track changes.
30
+
***DO** assume that ["Squash and Merge"](https://github.com/blog/2141-squash-your-commits) will be used to merge your commit unless you request otherwise in the PR.
30
31
***DO NOT** fix merge conflicts using a merge commit. Prefer `git rebase`.
31
32
***DO NOT** mix independent, unrelated changes in one PR. Separate real product/test code changes from larger code formatting/dead code removal changes. Separate unrelated fixes into separate PRs, especially if they are in different assemblies.
33
+
34
+
Merging Pull Requests (for contributors with write access)
***DO** use ["Squash and Merge"](https://github.com/blog/2141-squash-your-commits) by default for individual contributions unless requested by the PR author.
38
+
Do so, even if the PR contains only one commit. It creates a simpler history than "Create a Merge Commit".
39
+
Reasons that PR authors may request "Merge and Commit" may include (but are not limited to):
40
+
41
+
- The change is easier to understand as a series of focused commits. Each commit in the series must be buildable so as not to break `git bisect`.
42
+
- Contributor is using an e-mail address other than the primary GitHub address and wants that preserved in the history. Contributor must be willing to squash
0 commit comments