ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: improve wording about example count limit (#5760)

manned-org
FantasyCookie17 2021-04-15 19:16:25 +02:00 committed by GitHub
parent 5b399da211
commit 04a78338e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -30,7 +30,7 @@ To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the
The basic format of a `tldr` page is a set of concrete usage examples. The basic format of a `tldr` page is a set of concrete usage examples.
Here are a few guidelines to get started: Here are a few guidelines to get started:
1. Try to keep pages at around 5 examples. Pages can be longer if needed, but don't exceed 8 examples. 1. Try to keep pages at around 5 examples. Pages can be longer or shorter when appropriate, but don't exceed 8 examples.
Remember, it's OK if the page doesn't cover everything; that's what `man` is for. Remember, it's OK if the page doesn't cover everything; that's what `man` is for.
2. 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.
For example, commands that require `sudo` should include it directly in the examples. For example, commands that require `sudo` should include it directly in the examples.