|
|
@@ -39,22 +39,25 @@ Thanks for your contributions!
|
|
|
|
|
|
### Format of the Commit Message
|
|
|
|
|
|
-We follow a rough convention for commit messages borrowed from AngularJS. This
|
|
|
-is an example of a commit:
|
|
|
+We follow a rough convention for commit messages that is designed to answer two
|
|
|
+questions: what changed and why. The subject line should feature the what and
|
|
|
+the body of the commit should describe the why.
|
|
|
|
|
|
```
|
|
|
- feat(scripts/test-cluster): add a cluster test command
|
|
|
+scripts: add the test-cluster command
|
|
|
|
|
|
- this uses tmux to setup a test cluster that you can easily kill and
|
|
|
- start for debugging.
|
|
|
+this uses tmux to setup a test cluster that you can easily kill and
|
|
|
+start for debugging.
|
|
|
+
|
|
|
+Fixes #38
|
|
|
```
|
|
|
|
|
|
The format can be described more formally as follows:
|
|
|
|
|
|
```
|
|
|
-<type>(<scope>): <subject>
|
|
|
+<subsystem>: <what changed>
|
|
|
<BLANK LINE>
|
|
|
-<body>
|
|
|
+<why this change was made>
|
|
|
<BLANK LINE>
|
|
|
<footer>
|
|
|
```
|
|
|
@@ -63,25 +66,3 @@ The first line is the subject and should be no longer than 70 characters, the
|
|
|
second line is always blank, and other lines should be wrapped at 80 characters.
|
|
|
This allows the message to be easier to read on GitHub as well as in various
|
|
|
git tools.
|
|
|
-
|
|
|
-#### Subject Line
|
|
|
-
|
|
|
-The subject line contains a succinct description of the change.
|
|
|
-
|
|
|
-#### Allowed `<type>`s
|
|
|
-- *feat* (feature)
|
|
|
-- *fix* (bug fix)
|
|
|
-- *docs* (documentation)
|
|
|
-- *style* (formatting, missing semi colons, …)
|
|
|
-- *refactor*
|
|
|
-- *test* (when adding missing tests)
|
|
|
-- *chore* (maintain)
|
|
|
-
|
|
|
-#### Allowed `<scope>`s
|
|
|
-
|
|
|
-Scopes can anything specifying the place of the commit change in the code base -
|
|
|
-for example, "api", "store", etc.
|
|
|
-
|
|
|
-
|
|
|
-For more details on the commit format, see the [AngularJS commit style
|
|
|
-guide](https://docs.google.com/a/coreos.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).
|
Brandon Philips