Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: improve contributing documentation

Browse source 
- Fix name of file generated by `$ nix-build -A docs.manPages`.

- Note "Capitalize the subject line" as an exception to the seven
  rules. Not even the example commit message (closely below this
  change) follows this rule.
This commit is contained in:
hab25 2022-07-21 11:51:34 -03:00 committed by Robert Helgesson
parent 119febc464
commit b13946438f
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/contributing.adoc
View file

@ -105,7 +105,7 @@ When you have made changes to a module, it is a good idea to check that the man
[source,console]
$ nix-build -A docs.manPages
$ man ./result/share/man/man5/home-configuration.nix.5
$ man ./result/share/man/man5/home-configuration.nix.5.gz
==== Add yourself as a module maintainer
@ -155,7 +155,7 @@ A potential gotcha with respect to licensing are option descriptions. Often it i
The commits in your pull request should be reasonably self-contained, that is, each commit should make sense in isolation. In particular, you will be asked to amend any commit that introduces syntax errors or similar problems even if they are fixed in a later commit.
The commit messages should follow the {seven-rules}[seven rules]. We also ask you to include the affected code component or module in the first line. That is, a commit message should follow the template
The commit messages should follow the {seven-rules}[seven rules], except for "Capitalize the subject line". We also ask you to include the affected code component or module in the first line. That is, a commit message should follow the template
----
{component}: {description}