Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (31 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 1.29 KB

How to contribute

Contributions may include opening any issue or raising a pull request to resolve an issue. Please ask to be assigned to an issue if you are interested in contributing.

Using Make

  • GNU Make may be used for greater brevity and efficiency in the development process
  • Make rules invoke:
    • Virtual environment initialization
    • Dependency installation
    • Linting
    • Formatting
    • Running

Testing

  • Tests should conform to unittest conventions

Submitting changes

  1. Check out master
  2. Pull from origin master
  3. Branch from master
  4. Raise a PR back into master

Please raise one PR per issue if possible.

Coding conventions

  • Standards: PEP8
  • Indentation: 4 spaces
  • Encoding: UTF-8
  • Formatting: Black
  • Linting: Flake8
  • Naming
    • Functions: lower_case_with_underscores (snake_Case)
    • Variables: lower_case_with_underscores (snake_Case)
    • Modules: lower_case_with_underscores (snake_Case)
    • Packages: lower_case_with_underscores (snake_Case)
    • Classes: CapWords convention (PascalCase)

Andrew Brown (TM)