If you're reading this, it means you're probably looking to contribute to this repository. That's great! We really appreciate it. Read the following guidelines to make sure you help us out by making the best contribution you can. Most importantly, familiarize yourself with the Code of Conduct so we can all be better to each other.
If you spot a problem with the code or documentation, or if you want to request an enhancement, create an issue. For smaller changes, we prefer a pull request being made without an issue, but if you don't have the means to make a pull request right away, feel free to create an issue anyway. Be sure to explain why you think the change should be made, as well as a sufficient amount of detail about what needs changing. This includes a step by step method of reproducing any bugs (preferably with some sample code).
We use conventional commits in this repository, so please ensure all commits in your pull request match this pattern. If the pull request addresses an issue, include closes #<issue_number> in your pull request title. e.g: feat: make the doohickey wobble closes #42
Wait for a review from a member of our team and address any comments we make. Feel free to disagree and suggest better strategies. That is what makes open source software so great! Remember to follow the Code of Conduct as you do so.
Make sure any code changes are accompanied by appropriate tests that do not decrease the code coverage. The easiest way to do this is to follow test-driven develpoment.
Please respect the Code of Conduct when contibuting to this repository. The Code of Conduct can be found here.