innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Doc'd how to use GitHub's "Squash and merge" button.

This commit is contained in:
Tim Graham 2016-09-21 12:13:21 -04:00 committed by GitHub
parent cf0b402518
commit ddef397b0d
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/internals/contributing/committing-code.txt
View File

@ -70,8 +70,11 @@ pull request "Merged in XXXXXXX" (replacing with the commit hash) after you
merge it. Trac checks for this message format to indicate on the ticket page merge it. Trac checks for this message format to indicate on the ticket page
whether or not a pull request is merged. whether or not a pull request is merged.
Avoid using GitHub's "Merge pull request" button on the website as it creates If a pull request doesn't need to be merged as multiple commits, you can use
an ugly "merge commit" and makes navigating history more difficult. GitHub's "Squash and merge" button on the website. Edit the commit message as
needed to conform to :ref:`the guidelines <committing-guidelines>` and remove
the pull request number that's automatically appended to the message's first
line.
When rewriting the commit history of a pull request, the goal is to make When rewriting the commit history of a pull request, the goal is to make
Django's commit history as usable as possible: Django's commit history as usable as possible: