Inkdpixels/commit-analyzer

# @inkdpixels/commit-analyzer

[![Greenkeeper badge](https://badges.greenkeeper.io/Inkdpixels/commit-analyzer.svg)](https://greenkeeper.io/)
[![Build Status](https://travis-ci.org/Inkdpixels/commit-analyzer.svg)](https://travis-ci.org/Inkdpixels/commit-analyzer) [![Dependency Status](https://david-dm.org/Inkdpixels/commit-analyzer.svg)](https://david-dm.org/inkdpixels/commit-analyzer) [![devDependency Status](https://david-dm.org/Inkdpixels/commit-analyzer/dev-status.svg)](https://david-dm.org/inkdpixels/commit-analyzer#info=devDependencies) [![Code Climate](https://codeclimate.com/github/Inkdpixels/commit-analyzer/badges/gpa.svg)](https://codeclimate.com/github/Inkdpixels/commit-analyzer) [![Test Coverage](https://codeclimate.com/github/Inkdpixels/commit-analyzer/badges/coverage.svg)](https://codeclimate.com/github/Inkdpixels/commit-analyzer/coverage)

> A commit-analyzer plugin for semantic-release which uses the commit guidelines of [Neos](https://www.neos.io/).

## Installation
```js
npm i -D @inkdpixels/commit-analyzer
```

## Setup & Configuration
Specify the custom commit-analyzer plugin in your projects `package.json`.

```js
{
  "release": {
    "analyzeCommits": "@inkdpixels/commit-analyzer"
  }
}
```

## Commit message guidelines
Every commit message should have a prefix, which is surrounded by square brackets.
Below is a list of available prefixes and what kind of release they will trigger once they are in your preferred git release branch.

| Prefix        | Description     | Release type  |
| ------------- | --------------- | ------------- |
| `!!!`         | Breaking change | Major         |
| `FEATURE`     | Feature         | Minor         |
| `BUGFIX`      | Bugfix          | Patch         |
| `SECURITY`    | Security change | Patch         |
| `TASK`        | Other changes   | No release    |

More infos regarding the commit message guidelines can be found in the official [discuss forum](https://discuss.neos.io/t/commit-message-style/507). You may also want to use the [generateNotes plugin](https://github.com/Inkdpixels/release-notes-generator) for this commit style & analyzer.

## Contributing
We use xo to lint the code, please take care to run `npm test` before you commit something.
If you add or modify methods or the API, please add unit tests as specified in the `*.spec.js` files.

## License
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.