Bijdragen

Commitconventies

Conventional Commits + hoe versies worden afgeleid.

routess gebruikt Conventional Commits. semantic-release leest commits om de volgende versie te bepalen.

Formaat

<type>(<scope>)?: <subject>

[body]

[footer]

Types

TypeBumptVoorbeeld
featminorfeat(routes): add gpx export
fixpatchfix(api): handle 401 from google jwks
chore, docs, style, refactor, test, ci, perf, buildgeenchore: update deps
feat!: of BREAKING CHANGE: in de bodymajorfeat!: drop /v1, switch to /v2

Tips

  • Houd het subject onder ~70 tekens
  • Gebruik de kleine-letter gebiedende wijs ("add", niet "Adds" of "Added")
  • Scopes zijn optioneel maar helpen: feat(web), fix(api), docs(packages)

Niet doen

  • Squash geen ongerelateerde wijzigingen in één commit
  • Gebruik geen chore voor zichtbare wijzigingen voor gebruikers; die komen niet in de changelog

On this page