You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,6 +119,8 @@ To keep consistency throughout the Markdown files in the Open Container spec all
119
119
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
120
120
For example, this paragraph will span three lines in the Markdown source.
121
121
122
+
## Git commit
123
+
122
124
### Sign your work
123
125
124
126
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.)
171
173
172
174
You can add the sign off when creating the git commit via `git commit -s`.
173
175
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: ...")
0 commit comments