Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1.16 KB

CONTRIBUTING

Bugs or Suggestions

Just go to the issues page on Github and open a new issue. Please include as much detail as possible.

Code

Testing

We're using the nose test runner with the standard unittest-based tests. New pull requests must have passing tests.

Code Style

  • Use Sublime Lint and fix all warnings.
  • Maintain the documentation along with the code!
  • Four spaces, no tabs.
  • Function names use snake_case.
  • Class names use PascalCase.
  • Place string constants in constants.py.

Instructions

  1. Go to the project page on Github
  2. Fork the project by clicking the Fork button
  3. Clone your own copy of the project
  4. Make your changes
  5. Push your changes back up to Github
  6. Submit a Pull Request

Thanks for your help and support!