Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

This project does not allow any use of AI systems in any capacity.

Development

Branching

This project uses trunk-based development.
All feature branches should be short-lived and merge directly back into main.

Releases

We use Semantic Versioning.
Releases are marked only with git tags on the main branch.

Tagging

Tags follow Semantic Versioning without a v prefix.

Commit Schema

We follow Conventional Commits.

Types

TypeDescriptionChangelog
featNew featuresIncluded
docsDocumentation changesIncluded
depsDependency updatesIncluded
choreMaintenance tasksNot included

Scoping

Scoping is only allowed when working on a specific issue.
Use the issue key as the scope.

Example feat(#123): add xyz

Scoping for other things is not permitted.