- Clone/Fork the repo
- Install dependencies:
npm install - Ensure linters pass:
npm run lint - Ensure tests pass:
npm test - Make changes and then make sure the linters and tests still pass
- Push your branch/fork and submit a PR
- Assign a sparkboxer to review your PR
We use Conventional Commits on this project. Commit messages must be prefixed with a valid commit type and the commit type cannot be prefixed with any additional text.
Supported commit types include feat, fix, chore, docs, style, refactor, and test.
Valid example:
feat: add new linting rule for ...Invalid examples:
feature: add new linting rule for ...:sparkles: feat: add new linting rule for ...ℹ️ See the Conventional Commits page for further details on available commit types and how to handle breaking changes.
If your PR is approved, the person who reviewed it will merge it into the main branch, triggering the deployment to production.