lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-09-10 13:33:43 +02:00
Code Activity

Numbered list of rules in Contributing Rules instead of bulled list

Browse source
This commit is contained in:
Igor Shubovych 2015-12-25 12:20:32 +02:00
parent d2c7181f9a
commit 57edcb9456
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -16,12 +16,12 @@ When setting up a brand new fork, run `make setup` to install the git pre-commit
Note that `tldr` is focused on concrete examples. Note that `tldr` is focused on concrete examples.
Here's a few guidelines to get started: Here's a few guidelines to get started:
- Focus on the 5 or 6 most common usages. It's OK if the page doesn't cover everything; that's what `man` is for. 1. Focus on the 5 or 6 most common usages. It's OK if the page doesn't cover everything; that's what `man` is for.
- When in doubt, keep new command-line users in mind. Err on the side of clarity rather than terseness. 2. When in doubt, keep new command-line users in mind. Err on the side of clarity rather than terseness.
- Try to incorporate the spelled-out version of single-letter options in the example's description. 3. Try to incorporate the spelled-out version of single-letter options in the example's description.
- Introduce options gradually, starting with the simplest commands and using more complex examples progressively. 4. Introduce options gradually, starting with the simplest commands and using more complex examples progressively.
- Use short but descriptive values for the tokens, ex. `{{source_file}}` or `{{wallet.txt}}`. 5. Use short but descriptive values for the tokens, ex. `{{source_file}}` or `{{wallet.txt}}`.
- Be specific: avoid explaining general UNIX concepts that could apply to any command (ex: relative/absolute paths, brace expansion, character escaping...) 6. Be specific: avoid explaining general UNIX concepts that could apply to any command (ex: relative/absolute paths, brace expansion, character escaping...)
The best way to be consistent is to have a look at a few existing pages :) The best way to be consistent is to have a look at a few existing pages :)