From 7d8dce609cb3138bd7e20df05783d1e931b312b3 Mon Sep 17 00:00:00 2001 From: Simonmicro Date: Sat, 3 Oct 2020 22:27:01 +0200 Subject: [PATCH] Contribution guidelines (#101) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added first draft * Added pep ref * contributing minor adjustments Co-authored-by: Matteo ℱan --- docs/Contributing.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/Contributing.md diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..6718bae --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,15 @@ +# Contributing + +You want to improve this project? +Awesome! But before you write 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 return) +- For the rest a bit as it comes with a look at [PEP8](https://www.python.org/dev/peps/pep-0008/) :)