diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13ad2c0..7ad3b31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 +environment: write new keys in consistent order - this uses tmux to setup a test cluster that you can easily kill and - start for debugging. +Go 1.3 randomizes the ordering of keys when iterating over a map. +Sort the keys to make this ordering consistent. + +Fixes #38 ``` The format can be described more formally as follows: ``` -(): +: - +