Conform to best practicesΒΆ

We follow these practices when developing Raspberry IO code:

  1. We generally follow the git flow model of development, which means most of your work will be on a feature branch off the develop branch.
  2. Follow PEP 8 style conventions. Use 4 spaces instead of tabs.
  3. Use CapitalizedCase for class names, underscored_words for method names.
  4. Code using os.path must be Windows and ‘NIX friendly. For example, don’t use backslashes (\) as path separators.
  5. Be sure every class and method has docstrings.
  6. Use Python logging whenever an error or exception occurs. Optionally include debug-level logging.
  7. Write a test which shows that the bug was fixed or that the feature works as expected.
  8. Run the test suite to make sure nothing unexpected broke. We only accept pull requests with passing tests.
  9. Write new or update existing documentation to describe the changes you made.
  10. Add the change to the CHANGELOG for the next release.
  11. Add your name to the AUTHORS file
  12. Submit a pull request and get reviews before merging your changes, even if you have authority to merge the changes yourself.

Project Versions

Previous topic

Submit a pull request

Next topic

Write documentation

This Page