Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.43 KB
Raw

Contributing

Commit messages

Commit messages must follow the Angular-style commit format (but excluding the scope).

i.e:

fix: minified scripts being removed

Also includes tests

This will allow for the automatic changelog to generate correctly.

Commit types

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • perf: A code change that improves performance

To release a major you need to add BREAKING CHANGE: to the start of the body and the detail of the breaking change.

Code standards

Ensure to use black and flake8.

Sending pull requests

  • add tests for newly added code
  • spell check
  • PRs will not be code reviewed unless all tests are passing

Important: when fixing a bug, please commit a failing test first so that it is easy to see the code failing. Once that commit is in place, then commit the bug fix, so that we can test before and after.