Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.53 KB
Raw

Contributing

Reporting issues or suggesting features

  • First search the open issues to see if someone has already created a similar issue
  • If you find an existing issue, sit tight. Please do not comment just to say "+1" or "me too".
  • If your issue is unique, file a new issue here.

Getting started

BEFORE YOU START: Please create an issue that documents your change before you submit a PR.

  1. Fork the repository
  2. Install dependencies by running npm install
  3. Run npm run verify && npm run build to ensure the package builds successfully without any changes
  4. Write the code for your feature/fix
  5. Write tests for the change - ensuring that every code branch is effectively tested
  6. Update the documentation as necessary
  7. Run npm run verify && npm run build before committing to ensure the code passes all tests/linters/etc
  8. Commit your changes following the Commit message conventions below
  9. Submit a PR for review

Commit message conventions

We are following the Conventional Commits format as popularized by the Angular commit format. This is enforced by commitlint and used to automatically publish new versions with semantic-release.

At a minimum, every commit message should include following:

<type>: <short summary>

You can optionally include a body or footer if there's additional information that's important to add to the commit message:

<type>: <short summary>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

type

Must be one of the following:

  • fix: Bug fix (PATCH version)
  • perf: Performance improvement (PATCH version)
  • feat: New feature (MINOR version)
  • refactor: Changes source code without affecting functionality in any way (no new version)
  • docs: Update documentation only (no new version)
  • test: Add/update/fix test (no new version)

short summary

A brief description of the change. Use the imperative, present tense: "fix" not "fixed" nor "fixes".

body

Additional information to expand on the short summary

footer

If the change is a breaking change, be sure to start this section with BREAKING CHANGE: <breaking change summary> and go on to summarize the migration instructions.