From 6aec85e6c21aec29173523eaa141f7b28f314b0d Mon Sep 17 00:00:00 2001 From: Soonho Kong Date: Wed, 25 Sep 2013 19:43:42 -0700 Subject: [PATCH] doc(commit_convention): add git commit_convention --- README.md | 1 + doc/commit_convention.md | 77 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 doc/commit_convention.md diff --git a/README.md b/README.md index e316887cd..1c432399f 100644 --- a/README.md +++ b/README.md @@ -49,4 +49,5 @@ Miscellaneous - [Testing and Code Coverage](doc/make/coverage.md) - Building Doxygen Documentation: `doxygen src/Doxyfile` - [Coding style](doc/coding_style.md) +- [Git Commit Convention](doc/commit_convention.md) - [Automatic builds](doc/make/travis.md) diff --git a/doc/commit_convention.md b/doc/commit_convention.md new file mode 100644 index 000000000..ae18682eb --- /dev/null +++ b/doc/commit_convention.md @@ -0,0 +1,77 @@ +Git Commit Convention +===================== + +We are using the following convention for writing git-commit messages. +It is based on the one from AngularJS project([doc][angularjs-doc], +[commits][angularjs-git]). + +[angularjs-git]: https://github.com/angular/angular.js/commits/master +[angularjs-doc]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit# + +Format of the commit message +---------------------------- + + (): + + + +