mirror of
https://github.com/SystemRage/py-kms.git
synced 2024-12-26 10:01:09 +08:00
Contribution guidelines (#101)
* Added first draft * Added pep ref * contributing minor adjustments Co-authored-by: Matteo ℱan <SystemRage@protonmail.com>
This commit is contained in:
parent
5ffcbb8606
commit
7d8dce609c
1 changed files with 15 additions and 0 deletions
15
docs/Contributing.md
Normal file
15
docs/Contributing.md
Normal file
|
@ -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/) :)
|
Loading…
Reference in a new issue