CONTRIBUTING.md

Contribution Guidelines

Thank you for considering contributing to this project! Contributions are always welcome and appreciated.

How to Contribute

Please check the issue tracker to see if there is an issue you would like to work on or if it has already been resolved.

Reporting Bugs

1. Open an issue on the issue tracker.
2. Include information such as steps to reproduce, expected/actual behavior, and relevant logs or screenshots.

Suggesting Features

1. Open an issue on the issue tracker.
2. Provide details about the feature, its purpose, and potential implementation ideas.

Submitting Pull Requests

• Make sure all tests pass before submitting a pull request.
• Write a clear description of the changes you made and the reasons behind them.

Important

Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in the work, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

Development Workflow

Code Style

• Use the make rust-format command to format the code.

Running Tests

• Use the make rust-test and make test commands to run the tests.

Running Linters

• Use the make rust-lint command to run the linters.

See Available Commands

• Run make help to see all available commands for managing different tasks.

Code of Conduct

We adhere to the project's Code of Conduct.