Make the changes to the code and tests and then commit to your branch. Be sure to follow the commit message conventions.
This template includes:
Commit message summaries must follow this basic format:
* Typescript template
* Linting using TSLint
* Automatic releases using semantic-release (ESLint Code Convention) and Gitlab CI / CD
* For public registry: Publishing of packages, for usage add the following lines to package.json, uncomment the npm publish module in .releaserc and provide a valid NPM token:
```
```
Tag: Message (fixes #1234)
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/",
"tag": "latest"
}
```
```
`Tag` should not be confused with git tag.
* Automatic Unit tests using Mocha
`Message` should not be confused with git commit message.
* Automatic documentation publishing using Gitlab CI / CD and a self written script which puts the docs in the docs folder to the wiki
\ No newline at end of file
The `Tag` is one of the following:
*`Fix` - for a bug fix.
*`Update` - for a backwards-compatible enhancement.
*`Breaking` - for a backwards-incompatible enhancement.
*`Docs` - changes to documentation only.
*`Build` - changes to build process only.
*`New` - implemented a new feature.
*`Upgrade` - for a dependency upgrade.
The message summary should be a one-sentence description of the change. The issue number should be mentioned at the end. * The commit message should say "(fixes #1234)" at the end of the description if it closes out an existing issue (replace 1234 with the issue number). If the commit doesn't completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`.
Here are some good commit message summary examples:
```
Build: Update Travis to only test Node 0.10 (refs #734)
Fix: Semi rule incorrectly flagging extra semicolon (fixes #840)
Upgrade: Esprima to 1.2, switch to using Esprima comment attachment (fixes #730)
```
The commit message format is important because these messages are used to create a changelog for each release. The tag and issue number help to create more consistent and useful changelogs.
Based on https://github.com/eslint/eslint.github.io/blob/master/docs/developer-guide/contributing.md#step-2-make-your-changes
