Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.12 KB
Raw

✨ Thanks for contributing to bitconch-web3j! ✨

As a contributor, here are the guidelines we would like you to follow:

  • Ensure npm run ok passes before submitting a Pull Request
  • Features and bug fixes should be covered by new test cases
  • Commits follow the Angular commit convention

Creating releases

We use semantic-release to release new versions automatically from the master branch:

  • Commits of type fix will trigger bugfix releases, think 0.0.1
  • Commits of type feat will trigger feature releases, think 0.1.0
  • Commits with BREAKING CHANGE in body or footer will trigger breaking releases, think 1.0.0

All other commit types will trigger no new release.

Reference

Static Analysis

eslint and flow-type are used.

Helpful link: https://www.saltycrane.com/flow-type-cheat-sheet/latest/

Testing Framework

https://jestjs.io/

API Documentation

ESDoc is used to document the public API. See https://esdoc.org/manual/tags.html for details.