docs: add README.md and CHANGELOG.md

Change-Id: Ifa1c1059ab85e72e62c41529a337d7efc0ce042e
Issue-ID: USECASEUI-306
Signed-off-by: cyuamber <xuranyjy@chinamobile.com>

diff --git a/README.md b/README.md
index e36a518..215d9ee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,82 @@
+# Usecase UI
+
+This is the frontend part of Usecase UI project.
+
+
+### Getting Started
+
+1. Go to project folder and install dependencies:
+
+```bash
+npm install
+```
+
+2. Launch development server, and open `localhost:4200` in your browser:
+
+```bash
+npm start
+```
+
+### Project Structure
+
+### [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. 
+
+### Contributor
+
 Copyright 2017 CMCC Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-        http://www.apache.org/licenses/LICENSE-2.0
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/usecaseui-portal/CHANGELOG.md b/usecaseui-portal/CHANGELOG.md
new file mode 100644 (file)
index 0000000..2270210
--- /dev/null
+++ b/usecaseui-portal/CHANGELOG.md
@@ -0,0 +1,8 @@
+# [1.0.0](https://gerrit.onap.org/r/usecase-ui/compare/2.0.1...1.0.0) (2019-08-19)
+
+
+### Features
+
+* add loading for page ([45fe372](https://gerrit.onap.org/r/usecase-ui/commits/45fe372))
+* Home page style optimization ([19a945d](https://gerrit.onap.org/r/usecase-ui/commits/19a945d))
+

diff --git a/usecaseui-portal/package.json b/usecaseui-portal/package.json
index 701477d..70035a3 100644 (file)
--- a/usecaseui-portal/package.json
+++ b/usecaseui-portal/package.json
@@ -1,6 +1,6 @@
 {
   "name": "usecase-ui",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "scripts": {
     "ng": "ng",
@@ -8,7 +8,8 @@
     "build": "ng build --prod --aot",
     "test": "ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "ng e2e",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
   },
   "private": true,
   "dependencies": {
@@ -52,4 +53,4 @@
     "tslint": "~5.9.1",
     "typescript": "~2.5.3"
   }
-}
+}
\ No newline at end of file