From f61fb773e97ed9c139e347e8ce31492b8dc38e80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Gali=C4=87?= Date: Wed, 5 Sep 2018 17:55:26 +0200 Subject: [PATCH] add a contributing style-guide document --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..45721a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 +