Contribution guide

February 16, 2019 ยท View on GitHub

Below you can find sufficient information for successful contribution into the project.

Code style

ionic-native-http-connection-backend uses prettier on git hook to keep code consistent.

To enable git hooks run npm install before commiting.

Commit messages

ionic-native-http-connection-backend uses semantic-release to release new versions automatically.

To simplify valid commit message creation you can use npm run commit instead of git commit.

  • 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.

Unit testing

The project follows test-first approach. Please apply code changes alongside with unit tests.

Tests run with npm test command.

Ionic 3

The project accepts only bugfixes for Ionic 3.

Ionic 3 with ionic-native 4

For fixes on Ionic 3 with ionic-native 4 use ionic3-native4 branch.

Ionic 3 with ionic-native 5

For fixes on Ionic 3 with ionic-native 5 use ionic3-native5 branch.