From 92df44276d9e7ae7c7a61f8b63cc5e646eedee32 Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Wed, 18 Jun 2014 18:36:00 -0700 Subject: [PATCH] CONTRIBUTING: remove the subject verbs After talking to a few people on the team we have decided that the feat/fix/etc tags aren't adding much value. Use a simpler format instead. --- CONTRIBUTING.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13ad2c0..153b510 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 +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: ``` -(): +: - +