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

docs: minor fixes of guidelines

Browse source
This commit is contained in:
Robert Helgesson 2024-03-17 23:35:57 +01:00
parent 206f457fff
commit 7b3fca5adc
No known key found for this signature in database
GPG key ID: 96E745BD17AA17ED
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/manual/contributing/guidelines.md
View file

@ -69,13 +69,10 @@ All contributed code *must* pass the test suite.
## Add relevant documentation {#sec-guidelines-module-maintainer} ## Add relevant documentation {#sec-guidelines-module-maintainer}
Many code changes require changing the documentation as well. Module Many code changes require changing the documentation as well. The
options should be documented with [Nixpkgs-flavoured documentation is written in
Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup). [Nixpkgs-flavoured Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup).
Home Manager is itself documented using a combination of All text is hosted in Home Manager's Git repository.
[DocBook](https://tdg.docbook.org/) and
[AsciiDoc](https://asciidoc.org/). All text is hosted in Home Manager's
Git repository.
The HTML version of the manual containing both the module option The HTML version of the manual containing both the module option
descriptions and the documentation of Home Manager can be generated and descriptions and the documentation of Home Manager can be generated and
@ -105,6 +102,9 @@ If you are present in the nixpkgs maintainer list then you can use that
entry. If you are not then you can add yourself to entry. If you are not then you can add yourself to
`modules/lib/maintainers.nix` in the Home Manager project. `modules/lib/maintainers.nix` in the Home Manager project.
As a maintainer you are expected to respond to issues and
pull-requests associated with your module.
Maintainers are encouraged to join the IRC or Matrix channel and Maintainers are encouraged to join the IRC or Matrix channel and
participate when they have opportunity. participate when they have opportunity.