Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.27 KB
Raw

Contributing guide

The contribution is accepted via Pull Requests

Pull Requests

  • Follow the conventions used in the project. - Fix the code style with $ npm run lint.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your default branch, create branch, e.g. feature-name or bugfix-title.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests. Use appropriate labels.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. Please read How to write a good Git commit messages

Running Tests

$ npm test

Build

$ npm run build

Enjoy coding!