This guide is intended for maintainers (anybody with commit access).
Please make sure you're familiar with and follow the CODE_OF_CONDUCT.md.
- Ensure all checklist items are completed.
- Ensure any architectual decisions are captured in /docs/adr.
- Use "Squash and Merge". This keeps a clean history in
master
, with a full history available in Pull Requests. - Ensure the merge message conforms to Conventional Commits spec.
- Breaking changes? Ensure the commit message contains the text
BREAKING CHANGE:
.
Releasing is handled automatically when merging to master
, powered by CircleCI and semantic-release.