From 64e151dd3dc55f028bad775b404d9b7f1cd29ac0 Mon Sep 17 00:00:00 2001 From: coderaiser Date: Sun, 23 Jun 2013 14:00:37 -0400 Subject: [PATCH] doc(contribute) add commit message conventions --- CONTRIBUTING.md | 63 +++++++++++++++++++++++++++++++++++++------------ ChangeLog | 2 ++ 2 files changed, 50 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 269eb583..83671978 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,49 @@ -If you would like to contribute - send pull request to dev branch. -Getting dev version of **Cloud Commander**: - - git clone git://github.com/coderaiser/cloudcmd.git - git checkout dev - -or by [link](https://github.com/coderaiser/cloudcmd/tree/dev "Dev version"). - -It is possible thet dev version Cloud Commander will needed dev version of Minify, -so to get it you should type a couple more commands: - - cd node_modules - rm -rf minify - git clone git://github.com/coderaiser/minify - cd minify +Brunch +--------------- +If you would like to contribute - send pull request to dev branch. +Getting dev version of **Cloud Commander**: + + git clone git://github.com/coderaiser/cloudcmd.git git checkout dev + +or by [link](https://github.com/coderaiser/cloudcmd/tree/dev "Dev version"). + +It is possible thet dev version Cloud Commander will needed dev version of Minify, +so to get it you should type a couple more commands: + + cd node_modules + rm -rf minify + git clone git://github.com/coderaiser/minify + cd minify + git checkout dev + +Commit +--------------- +Format of the commit message: **type(scope): subject** + +**Type**: +- feature +- fix (bug fix) +- docs (documentation) +- style (formatting, missing semi colons, …) +- refactor +- test (when adding missing tests) +- chore (maintain) + +**Scope**: +Scope could be anything specifying place of the commit change. +For example util, console, view, edit, style etc... + +**Subject text**: +- use imperative, present tense: “change” not “changed” nor “changes” +- don't capitalize first letter +- no dot (.) at the end +**Message body**: +- just as in use imperative, present tense: “change” not “changed” nor “changes” +- includes motivation for the change and contrasts with previous behavior + +**Examples**: +- [fix(style) .name{width}: 37% -> 35%](https://github.com/coderaiser/cloudcmd/commit/94b0642e3990c17b3a0ee3efeb75f343e1e7c050) +- [fix(console) dispatch: focus -> mouseup](https://github.com/coderaiser/cloudcmd/commit/f41ec5058d1411e86a881f8e8077e0572e0409ec) + +**Big change should be writed in ChangeLog like [this](https://github.com/coderaiser/cloudcmd/commit/e1893f77be09585decf8a260d45a42efc11c98e5).** \ No newline at end of file diff --git a/ChangeLog b/ChangeLog index 4f0fb74c..fe91a717 100644 --- a/ChangeLog +++ b/ChangeLog @@ -76,6 +76,8 @@ getJSONfromFileTable. * doc(license) add +* doc(contribute) add commit message conventions + 2012.04.22, v0.2.0