diff options
| author | Tim Graham <timograham@gmail.com> | 2016-09-21 12:13:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-21 12:13:21 -0400 |
| commit | ddef397b0d0c44f8e45b467a6368b83e1102d0dd (patch) | |
| tree | b0c647f4654826bde3a3b10fead1a59a6db63b6f /docs/internals/contributing/committing-code.txt | |
| parent | cf0b4025182ce6484aa142bb203b74743c63a0ea (diff) | |
Doc'd how to use GitHub's "Squash and merge" button.
Diffstat (limited to 'docs/internals/contributing/committing-code.txt')
| -rw-r--r-- | docs/internals/contributing/committing-code.txt | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt index 7ed5aa3ed8..0877511dc8 100644 --- a/docs/internals/contributing/committing-code.txt +++ b/docs/internals/contributing/committing-code.txt @@ -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 whether or not a pull request is merged. -Avoid using GitHub's "Merge pull request" button on the website as it creates -an ugly "merge commit" and makes navigating history more difficult. +If a pull request doesn't need to be merged as multiple commits, you can use +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 Django's commit history as usable as possible: |