diff options
| author | Silvan Mosberger <contact@infinisil.com> | 2023-11-14 08:11:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-14 08:11:41 +0100 |
| commit | e89ad8355524b931cfd02512525d20a6dd73fa5d (patch) | |
| tree | 00e19d25ea8344e76a0baffde62a5183ad0cbfcb /pkgs/README.md | |
| parent | b0eb18fd1d087d371ef1a8d14ee6dd46bdcc9874 (diff) | |
| parent | e93a3d7b586022f900f176cf46e7a3bf211cfaf9 (diff) | |
Merge pull request #263059 from DanielSidhion/add-doc-convention
doc: commit header convention for documentation changes
Diffstat (limited to 'pkgs/README.md')
| -rw-r--r-- | pkgs/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/pkgs/README.md b/pkgs/README.md index 7f9b2fb220730..31a590e43d8d8 100644 --- a/pkgs/README.md +++ b/pkgs/README.md @@ -114,6 +114,25 @@ Now that this is out of the way. To add a package to Nixpkgs: 7. Optionally commit the new package and open a pull request [to nixpkgs](https://github.com/NixOS/nixpkgs/pulls), or use [the Patches category](https://discourse.nixos.org/t/about-the-patches-category/477) on Discourse for sending a patch without a GitHub account. +## Commit conventions + +- Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole. + +- Format the commit messages in the following way: + + ``` + (pkg-name): (from -> to | init at version | refactor | etc) + + (Motivation for change. Link to release notes. Additional information.) + ``` + + Examples: + + * nginx: init at 2.0.1 + * firefox: 54.0.1 -> 55.0 + + https://www.mozilla.org/en-US/firefox/55.0/releasenotes/ + ## Category Hierarchy [categories]: #category-hierarchy |