Skip to content

Latest commit

History

History
30 lines (19 loc) 路 898 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) 路 898 Bytes

How to contribute

First off, thanks for taking the time to contribute!

Submitting changes

Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding style

Start reading the code and you'll get the hang of it. It is optimized for readability:

  • Please also update the documentation.
  • Please check you Bash scripts with ShellCheck.
  • Please check your Python code with Flake8.
  • Be nice.

One more thing:

  • Keep it simple! 馃憤

Thanks! 鉂わ笍鉂わ笍鉂わ笍