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

add new guideline in CONTRIBUTING.md (#1116) 

* Update CONTRIBUTING.md

* add missing quotes in contributing.md

* Update CONTRIBUTING.md
waldyrious/alt-syntax
Yash Sharma 2016-10-14 23:41:41 +05:30 committed by Leandro Ostera
parent e20cde32ef
commit 1cf7bc7a63
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

@ -34,7 +34,7 @@ Here are a few guidelines to get started:
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.
2. When in doubt, keep new command-line users in mind.
Err on the side of clarity rather than terseness.
Err on the side of clarity rather than terseness. For example, commands that require `sudo` should include it directly in the examples.
3. Try to incorporate the spelled-out version of single-letter options in the example's description.
The goal is to allow people to *understand* the syntax of the commands, not just *memorize* it.
4. Introduce options gradually, starting with the simplest command invocations,