-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |