Thank you for considering contributing to our project! Please take a moment to review the following guidelines.
- All contributions to the project must be submitted via pull request.
- Ensure that your pull request addresses a specific issue or feature request. If none exists, please open a new issue first to discuss the changes you'd like to make.
- Follow the GitHub Flow workflow:
- Create a new branch from
main
. The branch name should start with the issue number. - Make your changes and commit them with descriptive commit messages.
- Submit a pull request to the main repository's
main
branch.
- Create a new branch from
- Ensure that your code adheres to the project's coding standards and conventions.
- Include unit tests if applicable and ensure that existing tests pass.
- Provide a clear and detailed description of your changes in the pull request description.
- Feel free to open an issue for bug reports, feature requests, or general feedback.
- When opening an issue, please provide as much detail as possible, including steps to reproduce for bug reports.
By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.