From 82835aa2a4a94955e7f3ce8381d59c3ec7670241 Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Wed, 9 Sep 2015 18:51:56 -0400 Subject: [PATCH] README.md: Add a git commit style guide Signed-off-by: Vincent Batts --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5eb434d78..3cf972db6 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,8 @@ To keep consistency throughout the Markdown files in the Open Container spec all This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length. For example, this paragraph will span three lines in the Markdown source. +## Git commit + ### Sign your work 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.) You can add the sign off when creating the git commit via `git commit -s`. +### Commit Style + +Simple house-keeping for clean git history. +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). + +1. Separate the subject from body with a blank line +2. Limit the subject line to 50 characters +3. Capitalize the subject line +4. Do not end the subject line with a period +5. Use the imperative mood in the subject line +6. Wrap the body at 72 characters +7. Use the body to explain what and why vs. how + * If there was important/useful/essential conversation or information, copy or include a reference +8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...") + [BlueJeans]: https://bluejeans.com/1771332256/