We welcome contributions to the project in the form of bug reports, feature requests, and pull requests.
If you find a bug in the project, please submit a bug report with the following information:
- A clear and concise description of the problem
- Steps to reproduce the issue
- The expected behavior
- The observed behavior
- Screenshots or gifs, if applicable
- The version of the project you are using
- Any additional context or information that may be relevant
If you have an idea for a new feature or improvement, please submit a feature request with the following information:
- A clear and concise description of the feature or improvement
- The problem or need that the feature addresses
- Any relevant context or information
- Screenshots or gifs, if applicable
To submit a pull request, please follow these steps:
- Fork the repository and create a new branch for your changes.
- Make your changes, following the project's coding style and including appropriate test coverage.
- Commit your changes and push them to your fork.
- Create a pull request against the master branch of the main repository.
- Fill out the pull request template, including a clear and concise description of the changes, screenshots or gifs, and information on how to test the changes.
- Wait for feedback and iterate as necessary.
Please make sure that your pull request follows the project's coding style and includes appropriate test coverage. Also, please make sure that you have tested your changes and that the pull request is ready for review.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you use this project, please include attribution to the original authors by linking back to this repository.
Thank you for your interest in contributing to the project!
You can edit this template to match your project's specific requirements