From e61795396f937ea14c1fc41949db9d59e48fe262 Mon Sep 17 00:00:00 2001 From: Simon Beginn Date: Sat, 3 Oct 2020 11:52:24 +0200 Subject: [PATCH] Added first draft --- docs/Contributing.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/Contributing.md diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..dd20518 --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,14 @@ +# Contributing + +You want to improve this project? Awesome! But before you wirte or modify the existing source code, please note the following guideline: + +- Always make sure to add your changes to the wiki. +- 8-space indentation without tabs. +- Docstrings as this: +```python + """ This is single line docstring. """ + """ This is a + """ multiline comment. +``` +- Wrap lines only if really long (it does not matter 79 chars PEP8) +- For the rest a bit as it comes :)