diff options
author | Mike Frysinger <vapier@google.com> | 2021-11-14 00:12:00 -0500 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2021-11-15 01:39:16 +0000 |
commit | f9e81c922dc7f8110f472f8e5e3a6ff61dd06c46 (patch) | |
tree | 3cd69834c54a7d01ab7ed5a990612e0c2520dacd | |
parent | e6601067ed5d2848f0610d6dd012e7707281a215 (diff) | |
download | git-repo-f9e81c922dc7f8110f472f8e5e3a6ff61dd06c46.tar.gz |
SUBMITTING_PATCHES: link to commit message style docs
Change-Id: I2090ebc43fc1c816b941a53dd89dbedf7bc61289
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/323696
Tested-by: Mike Frysinger <vapier@google.com>
Reviewed-by: Jack Neus <jackneus@google.com>
-rw-r--r-- | SUBMITTING_PATCHES.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/SUBMITTING_PATCHES.md b/SUBMITTING_PATCHES.md index 0c189247..76c167c3 100644 --- a/SUBMITTING_PATCHES.md +++ b/SUBMITTING_PATCHES.md | |||
@@ -3,7 +3,7 @@ | |||
3 | # Short Version | 3 | # Short Version |
4 | 4 | ||
5 | - Make small logical changes. | 5 | - Make small logical changes. |
6 | - Provide a meaningful commit message. | 6 | - [Provide a meaningful commit message][commit-message-style]. |
7 | - Check for coding errors and style nits with flake8. | 7 | - Check for coding errors and style nits with flake8. |
8 | - Make sure all code is under the Apache License, 2.0. | 8 | - Make sure all code is under the Apache License, 2.0. |
9 | - Publish your changes for review. | 9 | - Publish your changes for review. |
@@ -26,10 +26,11 @@ yourself with the following relevant bits. | |||
26 | 26 | ||
27 | ## Make separate commits for logically separate changes. | 27 | ## Make separate commits for logically separate changes. |
28 | 28 | ||
29 | Unless your patch is really trivial, you should not be sending | 29 | Unless your patch is really trivial, you should not be sending out a patch that |
30 | out a patch that was generated between your working tree and your | 30 | was generated between your working tree and your commit head. |
31 | commit head. Instead, always make a commit with complete commit | 31 | Instead, always make a commit with a complete |
32 | message and generate a series of patches from your repository. | 32 | [commit message][commit-message-style] and generate a series of patches from |
33 | your repository. | ||
33 | It is a good discipline. | 34 | It is a good discipline. |
34 | 35 | ||
35 | Describe the technical detail of the change(s). | 36 | Describe the technical detail of the change(s). |
@@ -171,3 +172,6 @@ After you receive a Code-Review+2 from the maintainer, select the Verified | |||
171 | button on the gerrit page for the change. This verifies that you have tested | 172 | button on the gerrit page for the change. This verifies that you have tested |
172 | your changes and notifies the maintainer that they are ready to be submitted. | 173 | your changes and notifies the maintainer that they are ready to be submitted. |
173 | The maintainer will then submit your changes to the repository. | 174 | The maintainer will then submit your changes to the repository. |
175 | |||
176 | |||
177 | [commit-message-style]: https://chris.beams.io/posts/git-commit/ | ||