Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.09 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Git

  • Make sure the commit message is short, simple and easy to understand.
  • Add the description of the change on the commit body. Explain what you changed and why you changed it and so on.

Python

Use pylama for linting.

1.Methods / Functions

  • Method names should be all lower case
  • Words in an method name should be separated by an underscore
  • Non-public method should begin with a single underscore
  • Method name should be logical, it's name should indicate what it is doing

2.Class

  • Class names should follow the UpperCaseCamelCase convention

3.Modules

  • Module names should be all lowercase
  • If more than one word, the words should be seperated by an underscore
  • It is preferrable to stick to single word for the module name

4.Constants

  • Constant variables should be capitalized
  • If more than one word, the words can be seperated by an underscore