Contributing Guidelines

Thank you for your interest in contributing to our project! Please take a moment to review these guidelines before diving in.

Getting Started

Fork the repository
Clone the forked repository to your local machine
Create a new branch for your features or bug fixes
Make the changes to your branch
Run all available tests to ensure that your changes do not break the existing functionality
run cargo fmt & fix warnings from cargo clippy
Push your changes to your forked repository
Submit a pull request to the original repository

Guidelines

For bigger changes open an issue to discuss beforehand and to align on changes
Follow the existing code style and conventions
Write clear commit messages (see https://cbea.ms/git-commit/)
Write tests for your code changes
Update documentation as necessary
Be respectful and welcoming to others in the community
Use descriptive names for your branches and pull requests

Code of Conduct

Please read and abide by our Code of Conduct

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

If you have any questions or need further assistance, please don't hesitate to reach out to us. We appreciate your contributions!