-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a contributing style-guide document
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|