Thank you for considering contributing to our open source project! We appreciate any contributions, whether they are in the form of bug reports, feature requests, code improvements, or documentation updates.
Before you start contributing, please read and understand our guidelines. By contributing, you agree to follow these guidelines and our code of conduct.
Our project follows the Contributor Covenant Code of Conduct. We expect all contributors to abide by its terms.
If you find a bug or have a feature request, please open an issue on our issue tracker. Please include a clear and concise description of the problem or request, along with any relevant information or steps to reproduce.
If you want to contribute code to our project, please follow these steps:
- Fork the project on GitHub.
- Create a new branch with a descriptive name for your changes.
- Make your changes on the branch. Please write clear and concise commit messages.
- Push your branch to your fork on GitHub.
- Create a pull request (PR) from your branch to our master branch. Please include a clear and concise description of your changes in the PR.
We will review your PR as soon as possible. We may ask you to make changes before we merge your changes into our master branch.
Before you submit your PR, please make sure that your changes:
. follow our code style and conventions . pass our automated tests . do not introduce new bugs or regressions
By contributing to our project, you agree that your contributions will be licensed under the project's LICENSE.