Commit Convention

To keep things consistent, commit messages should follow a format similar to Nixpkgs:

«scope»: «summary»

«motivation for change»

Where the scope is one of:

ScopePurpose
ciChanges to GitHub Actions workflows.
docChanges to the website, README.md, and so on.
stylixChanges in the stylix directory, flake.nix, and other global code.
Name of targetChanges to code for a particular target.
treewideChanges across many targets.

The scope is meant to indicate which area of the code was changed. Specifying the type of change, such as feat or fix, is not necessary. Dependency updates should use whichever scope they are related to.

The summary should start with a lowercase letter, and should not end with punctuation.

Most commits to master will also include a pull request number in brackets after the summary. GitHub adds this automatically when creating a squash merge.

Old commits

Commits before 2024 did not follow any particular format. Some have emojis from GitMoji.