feat(git): add angularjs git commit message conventions in the project

Change-Id: Ieed4da9792f5bc272f5ffaf34f49278c8f8964a5
Issue-ID: DCAEGEN2-1671
Signed-off-by: cyuamber <xuranyjy@chinamobile.com>

1 files changed, 51 insertions, 0 deletions

diff --git a/components/datalake-handler/admin/src/README.md b/components/datalake-handler/admin/src/README.md
index 4af92343..54d8c574 100644
--- a/components/datalake-handler/admin/src/README.md
+++ b/components/datalake-handler/admin/src/README.md
@@ -63,3 +63,54 @@ npm start
 > The layout is used for organizing a new module, **PLEASE** take care of the difference between `components` and `modules`. Make sure that all parts added in the `components` are `dump components` and all the parts which are related to the **business** should be added in the `modules`. Good luck 🙂.
 
 > The service folder is used for created some reused services. **PLEASE** put the specific services into the related folders. For example, put the toastr-notification service into the `components/toastr-notification` folder.
+
+### [Change log](./CHANGELOG.md)
+
+### Git commit message rules
+
+PLEASE obey [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#) when write the commit messages. One commit message should include three parts: `Header`, `Body` and `Footer`. The `Header` part is necessary, and the other two parts are optional. The `Header` part follows the rule as: `<type>(<scope>): <subject>`. `type` and `subject` are necessary, `scope` is optional. Only 7 tokens are allowed for `type`:
+   * feat: new features（feature）
+   * fix: fix bugs
+   * docs: documentation
+   * style: style
+   * refactor：reconstruction 
+   * test：add test
+   * chore：change for construction and assistant tools
+
+For example:
+
+```bash
+feat(directive): ng:disabled, ng:checked, ng:multiple, ng:readonly, ng:selected
+----------------------------------------------------- 
+docs(guide): updated fixed docs from Google Docs
+
+Couple of typos fixed:
+- indentation
+- batchLogbatchLog -> batchLog
+- start periodic checking
+- missing brace
+```
+
+
+When there is breaking changes in the project, please write the commit message in `Footer`. For example:
+
+```bash 
+    BREAKING CHANGE: isolate scope bindings definition has changed.
+
+    To migrate the code follow the example below:
+
+    Before:
+
+    scope: {
+      myAttr: 'attribute',
+    }
+
+    After:
+
+    scope: {
+      myAttr: '@',
+    }
+
+    The removed `inject` wasn't generaly useful for directives so there should be no code using it.
+```
+Also, run the script `npm run changelog` can generate all the `feat` and `fix` commits. Click [CHANGELOG.md](./CHANGELOG.md) shows all these commit histories.