Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.06 KB

CONTRIBUTING.rst

File metadata and controls

41 lines (28 loc) · 1.06 KB

Contributing to Box

Thank you for looking into supporting Box. Any constructive input is greatly appreciated!

Questions and Ideas

Even if you don't have code contributions, but just an idea, or a question about Box, please feel free to open an issue!

Reporting Bugs

  • Please include sample code and traceback (or unexpected behavior) of the error you are experiencing.
  • Also include Python version and Operating System.

Pull Requests

  • Follow PEP8
  • Select to merge into develop branch, NOT master
  • New features should have
    • Reasoning for addition in pull request
    • Docstring with code block example and parameters
    • Tests with as much coverage as reasonable
    • Tests should go through both sad and happy paths
  • Bug fixes should include
    • Explain under which circumstances the bug occurs in the pull request
    • Tests for new happy and sad paths
    • Test proving error without new code
  • Update CHANGES.rst to include new feature or fix
  • Add yourself to AUTHORS.rst!