Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 74a98d9

Browse files
Ryanf55tpwrules
authored andcommitted
Dev: clarify commit length and allow multiple commits per subsystem
Signed-off-by: Ryan Friedman <[email protected]>
1 parent 2c666eb commit 74a98d9

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

dev/source/docs/submitting-patches-back-to-master.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Preparing commits
2929
means that intermediate commits break the build. This also implies that
3030
moving code from one library to another happens in two commits: one that
3131
"deletes" it from the old spot, and a separate one that "creates" it at
32-
the new spot.
32+
the new spot. It's better for unrelated changes in a single library
33+
to be separate commits in the pull request.
3334

3435
- Do not create 'only fix formatting' commits. The disruption they cause
3536
to git history is more significant than their improvement to the code.
@@ -67,6 +68,8 @@ Preparing commits
6768

6869
do not save a parameter unless it has changed by 0.1%
6970

71+
- The brief description (summary) line should be less than 72 characters so it renders correctly in Github.
72+
7073
- **clean up your local commit history** :ref:`using interactive rebase <git-interactive-rebase>`
7174
(i.e. ``git rebase -i "HEAD~10"``) to re-arrange patches and fold things together. The idea is to present
7275
a logical set of patches for review. It can take a bit of effort to get

0 commit comments

Comments
 (0)