Thank you for considering contributing to this project! The following guidelines help ensure a smooth process for everyone.
Contributors are required to sign the CLA. This process is handled automatically by the CLA Assistant.
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
-
Fork the repository and create your branch from
main. -
Follow the coding style used in the project.
-
Install the pre-commit hook by running:
./.pre-commit/pre-commit --install
-
Write clear, concise commit messages.
-
Add tests for any new functionality.
-
Do not use unsafe Rust code.
-
Update documentation to complement code changes
- Use the Issue Tracker to report bugs or suggest enhancements.
- Check if the issue already exists before submitting.
- Provide steps to reproduce, expected vs. actual behavior, and relevant logs or screenshots.
- Open a pull request with a clear description of what it does and why.
- Link to the issue it fixes (if applicable).
- Ensure your branch is up to date with
main. - A maintainer will review and may request changes.
- Your PR will be reviewed by maintainers and may be merged after approvals.
- Use Conventional Commits specification for the commit messages
- Use the present tense (e.g., "feat: add command on cli" not "feat: added command on cli")
- Use imperative tone ("add command" not "adds command" or "adding command")
- Reference a ticket if applicable.
- Add more context and an explanation for the contribution.
By contributing, you agree that your contributions will be licensed under the same license as the project: LICENSE.