Skip to content
This repository has been archived by the owner on Sep 13, 2024. It is now read-only.

Latest commit

 

History

History
20 lines (15 loc) · 779 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 779 Bytes

Contributing

Happy to accept contribution. The easiest way to get a PR approved by me is to do the following. If you're unsure on any of these I'd still encourage you to submit your PR, and I'll just mention any changes necessary in the PR 😄

  • Correctly formating your PR with mix format
  • For public functions, some form of doc string is recommended
  • Some form of types for new functions or data structure
  • Some form of tests
    • For bug fixes just a test or tests to prevent any regresion
    • For features, just a test to prove it works as described

For any non trival change I'd recommended reaching out, the easiest way to find me is on twitter @ANGUS_KST or via email.