Skip to content

Commit

Permalink
feat(repo): add CONTRIBUTING file
Browse files Browse the repository at this point in the history
  • Loading branch information
christgau committed Feb 14, 2019
1 parent 91458ae commit 2617520
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Coding Conventions

* Use 4 spaces for indentation.
* Code conforms to PEP8. Use pep8 or pycodestyle with their default settings to check for compliance. Consider using a pre-commit hook to prevent non-conforming code from entering the repo.
* Avoid inline comments, prefer (short) block comments.
* Add documentation strings to function if required.
* If you want, add yourself to the AUTHORS file.

# Commit Conventions

* Follow [conventional commit](https://www.conventionalcommits.org) message guidelines.
* Scopes for commit messages are `etc`, `src` and file names from the root directory. Take a look at git log to get an impression.
* You can ignore the 50 chars limit for the first line of a commit message and obey to a hard limit of 72 chars.

0 comments on commit 2617520

Please sign in to comment.