Contribution Guide

Feel free to open issues here (https://github.com/cohalz/post-mackerel-annotation/issues) or contributing with Pull Requests. When opening up Pull Requests, make sure you follow the following flow:

Fork the repository from https://github.com/cohalz/post-mackerel-annotation/fork
Create your feature branch (e.g. git switch -c your-feature)
Commit and push your changes.
Make sure tests pass on your machine.

Tips on local development

Make sure you have the correct version of Node.js installed, as well as the dependencies.

$ npm install

Build and format.

$ npm run build && npm run format && npm run lint

Run the tests. These should pass.

$ npm test

Package for distribution.

$ npm package

Continuous Integration will fail if you do not push the diff from building and packaging.