Skip to content

Commit f6ec7a7

Browse files
author
Mrunal Patel
committed
Merge pull request #168 from vbatts/git-style-guide
README.md: adding a git style guide
2 parents b8bbd28 + 82835aa commit f6ec7a7

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
@@ -119,6 +119,8 @@ To keep consistency throughout the Markdown files in the Open Container spec all
119119
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
120120
For example, this paragraph will span three lines in the Markdown source.
121121

122+
## Git commit
123+
122124
### Sign your work
123125

124126
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.
@@ -171,4 +173,19 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
171173

172174
You can add the sign off when creating the git commit via `git commit -s`.
173175

176+
### Commit Style
177+
178+
Simple house-keeping for clean git history.
179+
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).
180+
181+
1. Separate the subject from body with a blank line
182+
2. Limit the subject line to 50 characters
183+
3. Capitalize the subject line
184+
4. Do not end the subject line with a period
185+
5. Use the imperative mood in the subject line
186+
6. Wrap the body at 72 characters
187+
7. Use the body to explain what and why vs. how
188+
* If there was important/useful/essential conversation or information, copy or include a reference
189+
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
190+
174191
[BlueJeans]: https://bluejeans.com/1771332256/

0 commit comments

Comments
 (0)