Welcome to our project! We're excited to have you here and appreciate your interest in contributing. Please take a moment to review these guidelines before making any contributions.
We expect all contributors to abide by our Code of Conduct. Please read it carefully and make sure you understand it before participating in any way.
There are many ways to contribute to our project, including:
- Reporting bugs
- Requesting features
- Fixing bugs
- Implementing new features
- Writing tests
- Improving documentation
- Reviewing code
- Fork the repository
- Clone your forked repository
- Create a new branch for your feature or bug fix
- Make changes and commit them
- Push your changes to your forked repository
- Open a Pull Request (PR) to the
main
branch of the original repository
We follow a set of code style guidelines to ensure consistency across the project. Please take a look at our Code Style Guidelines before making any contributions.
We require that all code changes are thoroughly tested. Please include tests with your changes and make sure all tests pass before submitting a PR.
All contributions will be reviewed by a maintainer. We may request changes or suggest improvements before merging your changes.
We appreciate your contributions and look forward to working with you.