Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.75 KB

Contribution guide

Developing LOAST

Please consider these guidelines when filing a pull request:

  • Commits follow the Angular commit convention
    • Commits messages are enforced using husky hooks and commitlint
    • Commitizen can be used to create commits following the correct format. This is integrated in a commit message hook, so can be accessed by simply typing git commit
      • You will need to install husky on the repo first by running ./node_modules/.bin/husky install
  • Prettier is used to enforce code style
  • eslint is used to enforce code quality
  • Features and bug fixes should be covered by test cases

Creating releases

LOAST uses semantic-release to release new versions automatically.

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

Note: The keyword, eg. fix, must be the first word in the commit message and be followed by a : in order to trigger a release. If the commit is the result of a github pull request being squashed and merged, the title of the pull request must start with the keyword. Periods cannot be in commit messages.

Creating PR

Include the associated JIRA ticket number so that JIRA hooks will automatically link the two togather.

  • Suggested format: "#Ticket Number#/ #Short description#"
  • Example: "API-1231/ Enhancement to test functionality"