Thank you for considering contributing to our project. We are always happy to receive contributions in the form of bug reports, feature requests, bug fixes and feature updates. The goal of this document is to outline the process of contributing to our project to ensure that everyone is on the same page and that contributions are made in a timely and efficient manner.
If you want to contribute code to the project, please follow these guidelines:
- Create a fork of the repository and make your changes on a new branch.
- Ensure that the code you are contributing follows the established coding style in the project.
- Provide unit tests for any new functionality or changes to existing functionality.
- Before submitting your code, run the unit tests locally to ensure that all tests pass.
- Submit a pull request to merge your changes back into the main repository.
- Wait for a review from one of our maintainers. If there are any issues, we will work with you to resolve them.
- Once the review is complete and your pull request is approved, your changes will be merged into the main repository.
If you encounter any bugs or have any feature requests, please open an issue on the project's GitHub repository. To create an issue, follow these steps:
- Give the issue a descriptive title that accurately describes the problem or feature request.
- Provide a clear and concise description of the problem or feature request.
- Provide steps to reproduce the problem if applicable.
- If you have a solution to the problem or a proposal for the feature request, please provide detailed instructions or a code snippet.