@@ -116,38 +116,41 @@ After your pull request is merged, you can safely delete your branch and pull th
116
116
To ensure consistency throughout the source code, keep these rules in mind as you are working:
117
117
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
118
118
* All public API methods **must be documented**. (Details TBC).
119
- * We follow [fulls1z3 ' s Angular TSLint rules][angular-tslint-rules ].
119
+ - We follow [eslint:recommended][eslint ].
120
120
121
121
## <a name="commit"></a> Commit message guidelines
122
122
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that
123
123
are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate
124
124
the `ngx-meta` change log**.
125
125
126
126
### Commit Message Format
127
- Each commit message consists of a ** header** , a ** body** and a ** footer** . The header has a special format that includes
128
- a ** type** , a ** scope** (* when applicable* ) and a ** subject** :
127
+ Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes
128
+ a **type** and a **subject**:
129
+
129
130
```
130
- < type>( < scope > ) : < subject>
131
+ <type>: <subject>
131
132
<BLANK LINE>
132
133
<body>
133
134
<BLANK LINE>
134
135
<footer>
135
136
```
136
137
137
- The ** header** is mandatory and the ** scope ** of the header is optional .
138
+ The **header** is mandatory.
138
139
139
140
Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as
140
141
well as in various git tools.
141
142
142
143
Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/)
143
144
if any.
144
145
145
- Samples: (even more [samples](https://github.com/fulls1z3/ngx-meta/commits/master))
146
+ Samples: (even more [samples](https://github.com/fulls1z3/universal/commits/master))
147
+
146
148
```
147
- docs(changelog) : update change log to alpha.4
149
+ docs: update change log to alpha.4
148
150
```
151
+
149
152
```
150
- fix(release) : need to depend on latest rxjs and zone.js
153
+ fix: need to depend on latest rxjs and zone.js
151
154
152
155
The version in our package.json gets copied to the one we publish, and users need the latest of these.
153
156
```
@@ -157,27 +160,20 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow
157
160
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
158
161
159
162
### Type
160
- Must be one of the following:
161
- * ** build** : Changes that affect the build system or external dependencies (example scopes: gulp, npm, webpack)
162
- * ** ci** : Changes to our CI configuration files and scripts (example scopes: Travis, Circle, etc)
163
- * ** docs** : Documentation only changes
164
- * ** feat** : A new feature
165
- * ** fix** : A bug fix
166
- * ** perf** : A code change that improves performance
167
- * ** refactor** : A code change that neither fixes a bug nor adds a feature
168
- * ** style** : Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
169
- * ** test** : Adding missing tests or correcting existing tests
170
163
171
- # ## Scope
172
- The scope should be the name of the project affected.
173
-
174
- The following is the list of supported scopes:
175
- * ** core**
176
-
177
- There are currently a few exceptions to the " use project name" rule:
164
+ Must be one of the following:
178
165
179
- * ** packaging** : used for changes that change the package layout (* e.g. package.json, bundles, path changes, etc.* )
180
- * ** changelog** : used for updating the release notes in CHANGELOG.md
166
+ - **feat**: A new feature
167
+ - **fix**: A bug fix
168
+ - **docs**: Documentation only changes
169
+ - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
170
+ - **refactor**: A code change that neither fixes a bug nor adds a feature
171
+ - **perf**: A code change that improves performance
172
+ - **test**: Adding missing tests or correcting existing tests
173
+ - **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
174
+ - **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
175
+ - **chore**: Other changes that don' t modify src or test files
176
+ - ** revert** : Reverts a previous commit
181
177
182
178
# ## Subject
183
179
The subject contains succinct description of the change:
@@ -198,4 +194,4 @@ message is then used for this.
198
194
199
195
[coc]: https://github.com/fulls1z3/ngx-meta/blob/master/CODE_OF_CONDUCT.md
200
196
[github]: https://github.com/fulls1z3/ngx-meta
201
- [angular-tslint-rules ]: https://github.com/fulls1z3/angular-tslint-rules
197
+ [eslint ]: https://github.com/eslint/eslint
0 commit comments