mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-10-30 16:10:36 +00:00
13 lines
877 B
Markdown
13 lines
877 B
Markdown
Thanks for contributing to the documentation.
|
||
|
||
Follow the [documentation style guide](https://github.com/NixOS/nixpkgs/blob/master/doc/styleguide.md), especially:
|
||
|
||
- Show, don’t tell. Start with a minimal working example. Explain after the code.
|
||
- Avoid meta-commentary. Don’t write "This section explains how to…".
|
||
- Use present tense, imperative mood, and active voice. For example: "Run the command," not "The user should run the following command."
|
||
- Avoid vague references like "this" when the referent is unclear. Write "This command creates a folder," not "This will create a folder."
|
||
- Be direct. Avoid "should", "might", "typically", and "usually".
|
||
- Cut filler words like "simply", "just", "easily", and "basically". Use "to" instead of "in order to".
|
||
|
||
For larger changes, such as adding or removing whole sections, ask the NixOS documentation team for review.
|