Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 2.4 KB

Contributing Guidelines

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.

This project welcomes non-code contributions too. The following types of contributions are welcome:

  • Ideas: participate in an issue thread or start your own to discuss your idea.
  • Writing: contribute your expertise in an area by helping expand the included docs.
  • Copy editing: fix typos, clarify language, and improve the quality of the docs.
  • Formatting: help keep the docs easy to read by using consistent formatting.

Code Style

This repository uses PEP8 to maintain code style and consistency.

Test folder names should be lowercase and end with _tests (e.g. error_generation_tests).

Test files should also be lowercase and end with _test.py (e.g. exceptions_tests.py).

All files and folders should be snake_case.

Rules

All Contributions are more than welcome but must be submitted using Pull requests that will then be reviewed.

Releases

Declaring formal releases remains the prerogative of the project maintainer.

Changes to this arrangement

This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.