Contribution Guidelines

Thank you for considering contributing to our project! Please follow these guidelines to make the process smooth for everyone involved.

Code of Conduct

We enforce a Code of Conduct to foster an inclusive and respectful community. Please adhere to it in all your interactions within the project.

How to Contribute

Reporting Bugs

If you encounter a bug, please ensure the bug hasn't been reported before by checking our issues on GitHub. If not, open a new issue with a clear description of the problem and steps to reproduce it.

Suggesting Enhancements

For feature requests or enhancements, feel free to open an issue as well. Provide a detailed explanation of the proposed feature and why it would be beneficial.

Pull Requests

We welcome pull requests from everyone! To contribute code, follow these steps:

1. Fork the repository and clone it locally.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure the code lints and tests pass.
4. Write clear commit messages.
5. Push your branch to your fork and open a pull request against the main branch.

Coding Style

• Follow the Rust style guidelines.
• Run cargo fmt to format your code before committing.

Testing

• Write tests for new code and ensure all tests pass before submitting a pull request.
• Run tests with cargo test.

Documentation

• Update documentation where necessary, including README.md, inline comments, and any relevant documentation files.
• Documentation is written in Markdown using VitePress, and can be previewed locally with npm run docs:dev.

License

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

Contact

If you have any questions or need further clarification, feel free to reach out to us via GitHub issues or email.

Thank you for contributing!