Skip to content

Commit

Permalink
add a contributing style-guide document
Browse files Browse the repository at this point in the history
  • Loading branch information
igalic authored and gronke committed Sep 5, 2018
1 parent 90656cd commit f61fb77
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contriuting

In order to contribute to this Handbook please be aware of the following style guide:

## Markdown

* We are using GitHub flavoured Markdown.
* The biggest header in chapters should be `h3`, or `###`
* Please ensure a (single) empty line before and after headers
* Each sentences should be put on its own line

## Glossary

The word "Jail" (as concept) should always be written as with upper-case J.
The word "jail" (command or system function) should always be written as `jail`.
To distinguish between the command and the function you can use the man page section: e.g.: `jail(8)`

## CoC

0 comments on commit f61fb77

Please sign in to comment.