We welcome and appreciate all types of contributions from the community, including bug reports, bug fixes, documentation improvements, enhancements, and ideas for new features.
- Fork the repository on GitHub.
- Clone the forked repository to your local machine.
- Create a new branch for your task.
- Make your changes.
- Push your changes to the branch in your forked repository.
When you're ready to contribute code, follow these steps:
- Ensure that your code adheres to the project's coding conventions and style guidelines.
- Add unit tests for any new code, and ensure all tests are passing.
- Add documentation comments for any new functionality or changes to existing functionality.
- Commit your changes with a descriptive commit message.
- Push your changes to your forked repository.
- Open a pull request against the main repository.
- Make sure all CI checks pass on your pull request.
If you encounter any bugs or issues, please submit them through the project's issue tracker on GitHub. Include as much information as possible in your bug report, including:
- A clear and concise description of the issue
- Steps to reproduce the issue
- Any relevant error messages or logs
- Your operating system and software versions
- Any other information that could help us diagnose and fix the issue
If you have an idea for a new feature or enhancement, submit it through the project's issue tracker on GitHub. Be sure to include:
- A clear and concise description of the enhancement
- An explanation of why this enhancement would be useful
- Any other information that could help us understand and prioritize your request
By participating in this project, you agree to abide by the project's code of conduct.
Thank you for your interest in contributing to our project!
Last updated on 16th July 2023