Contributing
Commit conventions
Conventional Commits + how versions are derived.
routess uses Conventional Commits. semantic-release reads commits to decide the next version.
Format
<type>(<scope>)?: <subject>
[body]
[footer]Types
| Type | Bumps | Example |
|---|---|---|
feat | minor | feat(routes): add gpx export |
fix | patch | fix(api): handle 401 from google jwks |
chore, docs, style, refactor, test, ci, perf, build | none | chore: update deps |
feat!: or BREAKING CHANGE: in body | major | feat!: drop /v1, switch to /v2 |
Tips
- Keep the subject under ~70 chars
- Use lowercase imperative mood ("add", not "Adds" or "Added")
- Scopes are optional but help:
feat(web),fix(api),docs(packages)
Don't
- Don't squash unrelated changes into one commit
- Don't use
chorefor user-visible changes; it won't show up in the changelog