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

small tweaks to CONTRIBUTING.md

waldyrious/alt-syntax
Waldir Pimenta 2016-01-08 02:01:59 +00:00
parent efa4cbd4de
commit 9b43655e35
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -26,7 +26,7 @@ The format of each page should match the following:
# command-name # command-name
> Short, snappy description. > Short, snappy description.
> Preferably one line, we can work with two. > Preferably one line; two are acceptable if necessary.
- Example description: - Example description:
@ -47,10 +47,11 @@ Some examples:
- `mysql {{database_name}}` - `mysql {{database_name}}`
- `unrar x {{compressed.rar}}` - `unrar x {{compressed.rar}}`
In short, make it as intuitive as possible for the user to figure out how to use In short, make it as intuitive as possible for the user to figure out
the command and fill it in with values. Stick to `snake_case` where possible. In how to use the command and fill it in with values.
some situations a command works with typical file extensions (like the `unrar` Stick to [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) where possible.
example above); you are encouraged to add these for demonstration. In some situations a command works with typical file extensions
(like the `unrar` example above); you are encouraged to add these for demonstration.
One of the reasons for this format is that it's well suited for command-line One of the reasons for this format is that it's well suited for command-line
clients that need to extract a single description/example. clients that need to extract a single description/example.