CONTRIBUTING.md

Commit Messages

I use a conventional changelog format so I can update my changelog automatically using clog

• Please format your commit subject line using the following format: TYPE(COMPONENT): MESSAGE where TYPE is one of the following:
  • feat - A new feature of an existing API
  • perf - A performance improvement
  • fix - A bug fix
  • docs - Changes to documentation only
  • test - Changes to the testing framework or tests only
  • refactor - Code functionality doesn't change, but underlying structure may
  • style - Stylistic changes only, no functionality changes
  • wip - A work in progress commit (Should typically be git rebase'ed away)
  • chore - Catch all or things that have to do with the build system, etc
• The COMPONENT is optional, and may be a single file, directory, or logical component. Parenthesis can be omitted if you are opting not to use the COMPONENT.

Releasing

Remember to bump the version numbers in:

• Cargo.toml
• snap/snapcraft.yaml

Also remember to update CHANGELOG.md with something like: clog --setversion 0.2.3