Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (15 loc) · 767 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 767 Bytes

How to contribute

Thanks for taking the time to contribute to this open source project 👍.

Submitting changes

Please open a GitHub pull request with a clear list of changes made (read more about pull requests).

Always write a clear commit message. Larger changes should follow the below structure:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

Testing

Unit tests should be written where applicable using the Pytest framework.

Coding conventions

  • Black should be used for formatting Python code.
  • Pyre should be used for type checking.