diff options
author | 2019-08-19 18:45:45 +0800 | |
---|---|---|
committer | 2019-08-19 18:45:56 +0800 | |
commit | ebd842c6737c3a2078a4d33babc4048e9bbaaf86 (patch) | |
tree | e0d640dc0cc5e0d6ed3d93410bd8203e2f3e45f5 /README.md | |
parent | 15235e6fc3bf84bc14d56e6604e2a76cfcc07db8 (diff) |
fix: fix bugs of positions of README.md
Change-Id: I1e88b1dc766a9b9f355e77c02a20661f308847e1
Issue-ID: USECASEUI-307
Signed-off-by: cyuamber <xuranyjy@chinamobile.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 85 |
1 files changed, 0 insertions, 85 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 215d9ee2..00000000 --- a/README.md +++ /dev/null @@ -1,85 +0,0 @@ -# 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 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. |