Skip to content

Commit 82835aa

Browse files
committed
README.md: Add a git commit style guide
Signed-off-by: Vincent Batts <[email protected]>
1 parent cbda521 commit 82835aa

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ To keep consistency throughout the Markdown files in the Open Container spec all
115115
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
116116
For example, this paragraph will span three lines in the Markdown source.
117117

118+
## Git commit
119+
118120
### Sign your work
119121

120122
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.
@@ -167,4 +169,19 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
167169

168170
You can add the sign off when creating the git commit via `git commit -s`.
169171

172+
### Commit Style
173+
174+
Simple house-keeping for clean git history.
175+
Read more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) or the Discussion section of [`git-commit(1)`](http://git-scm.com/docs/git-commit).
176+
177+
1. Separate the subject from body with a blank line
178+
2. Limit the subject line to 50 characters
179+
3. Capitalize the subject line
180+
4. Do not end the subject line with a period
181+
5. Use the imperative mood in the subject line
182+
6. Wrap the body at 72 characters
183+
7. Use the body to explain what and why vs. how
184+
* If there was important/useful/essential conversation or information, copy or include a reference
185+
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
186+
170187
[BlueJeans]: https://bluejeans.com/1771332256/

0 commit comments

Comments
 (0)