Thank you for your interest in contributing to this project! Read on for information on how to contribute.
Bug reports should be submitted via the Issues tab following these steps:
- First, check whether there already is an open issue for your bug.
- If an open issue for your bug doesn't already exist, then submit an issue.
- Please include enough detail to reproduce the issue.
Requests for new functionality or enhancements to existing functionality can also be submitted via the Issues tab. Just like with bug reports, please verify that there isn't already an existing issue covering the same request.
If you would like to more actively contribute with a bug fix, then follow this procedure:
- Fork the repository.
- Create a branch for the patch.
- Include a unit test (or tests) that demonstrate the bug (i.e., that fail without your patch, but passes with your patch).
- All existing unit tests must continue to pass.
- Submit a pull request.
If you would like to contribute new features and functionality, then follow the following procedure:
- Fork the repository.
- Create a branch for the feature.
- Implement the new functionality.
- Include unit tests that thoroughly test the new functioality.
- All existing unit tests must continue to pass.
- Submit a pull request.