nix/11.stylix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
11.stylix/docs/src/commit_convention.md
NAHO 81148743b9
doc: remove documentation about legacy commit conventions (#672) 
Remove legacy documentation about commit message conventions predating
the standardized format introduced in commit bf31640f49 ("doc: specify
commit message format") on 2024-01-23, with the final GitMoji usage in
commit 5a7f3f15cc ("Add guide for creating modules 📝").
2024-12-10 18:12:25 +00:00

1.3 KiB
Raw Blame History

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:

Scope Purpose
ci Changes to GitHub Actions workflows.
doc Changes to the website, README.md, and so on.
stylix Changes in the stylix directory, flake.nix, and other global code.
Name of target Changes to code for a particular target.
treewide Changes 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.