diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4edbf6a63..2a55ddd0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,47 +30,32 @@ The coding style suggested by the Golang community is used in etcd. See [style d Please follow this style to make etcd easy to review, maintain and develop. -### Format of the commit message +### Format of the Commit Message -etcd follows 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 more formally described as follows: +The format can be described more formally as follows: ``` -(): +: - +