Define the Conventional Commits types currently used by the project. Document the initial scope vocabulary for APT integration, hook wiring, ZFS behavior, configuration, and documentation. Require every future commit to carry a scope and keep verbose commit body lines within the repository's 72-character limit. Require new types and scopes to be documented before they are used.
1.1 KiB
1.1 KiB
Contributing
Commit conventions
This project uses Conventional Commits. Every commit must have a scope:
type(scope): imperative summary
The project currently uses these commit types:
feat: adds user-visible functionalityfix: corrects an incorrect or unsafe behaviorrefactor: changes internal structure without changing intended behaviordocs: changes documentation onlymeta: changes project conventions, repository metadata, or contribution filesbuild: changes installation, packaging, or deployment integration
The project currently uses these scopes:
apt: APT and Debian package-manager behaviorhook: APT hook configuration and invocation wiringzfs: ZFS selection, snapshot naming, and retention behaviorconf: Runtime configuration parameters and defaultsdocs: README and explanatory documentation
Add a new type or scope to this document before using it. Keep commit subjects concise and imperative. Commit bodies should explain the motivation and the resulting behavior, with body lines no longer than 72 characters.