MAINTAINING.md

Maintaining

This guide is intended for maintainers (anybody with commit access).

• Code of Conduct
• Setup
• Reviewing Pull Requests
• Approving Pull Requests

Code of Conduct

Please make sure you're familiar with and follow the CODE_OF_CONDUCT.md.

Setup

The GitHub repo requires an NPM_TOKEN secret. This is used to publish the npm package via GitHub Actions.

• npm login
• npm token create
• Add NPM_TOKEN to the GitHub repo secrets

Reviewing Pull Requests

Checklist:

1. Any decisions to capture as an ADR?
2. Any FAQs to update? E.g. README.md or DEVELOPING.md

Approving Pull Requests

1. Use "Squash and Merge". This keeps a clean history in master, with a full history available in Pull Requests.
2. Ensure the merge message conforms to Conventional Commits spec.
3. Breaking changes? Ensure the commit message contains the text BREAKING CHANGE:.