Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 1.02 KB

Contributing

You are welcome to contribute to the project by forking the repository and sending pull requests to the master branch. Please follow the style of the surrounding code to keep it consistent.

Requirements for the PR

  1. Please include in the description a thorough explanation of what you are changing and why this change is necessary.
  2. I would prefer to see more comments than less as comments that may not be deemed necessary now could be extremely beneficial for the future for understanding why it was done a certain way.
  3. When writing tests, make sure to: a. Only test one bit of functionality per test and make sure the name of the test aligns with this b. Tests should be split into arrange, act and assert for readability if possible c. Unit test coverage should be high and try to cover all edge cases and race conditions

License

By contributing to this code base you are agreeing to the terms of the MIT license. All files included in this project are included within this license.