Skip to content

Commit

Permalink
small tweaks to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
waldyrious committed Jan 8, 2016
1 parent efa4cbd commit 9b43655
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The format of each page should match the following:
# command-name
> Short, snappy description.
> Preferably one line, we can work with two.
> Preferably one line; two are acceptable if necessary.
- Example description:
Expand All @@ -47,10 +47,11 @@ Some examples:
- `mysql {{database_name}}`
- `unrar x {{compressed.rar}}`

In short, make it as intuitive as possible for the user to figure out how to use
the command and fill it in with values. Stick to `snake_case` where possible. In
some situations a command works with typical file extensions (like the `unrar`
example above); you are encouraged to add these for demonstration.
In short, make it as intuitive as possible for the user to figure out
how to use the command and fill it in with values.
Stick to [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) where possible.
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
clients that need to extract a single description/example.
Expand Down

0 comments on commit 9b43655

Please sign in to comment.