How to Contribute

How to Contribute

🛠 Setting Up the Project

1. Install Rust Ensure you have Rust installed. We recommend using rustup:

   rustup update

2. Install Pre-commit Hooks This project uses pre-commit to enforce code quality checks automatically. Install and activate the hooks:

   pipx install pre-commit
   pre-commit install

3. Install Spellcheck This project uses spellcheck. Install the tool:

   cargo install cargo-spellcheck

4. Build and Test Run the following commands to verify everything is working:

   cargo build
   cargo test

5. Build and Test The project documentation is generated using Hugo. Install the following requirements:

   • Go
   • Hugo

🚀 Making Contributions

• Follow Rust’s coding conventions and ensure your code is formatted with cargo fmt:

  cargo fmt --all

• Run clippy for linting:

  cargo clippy --all-targets --all-features

• Ensure all tests pass:

  cargo test

• Run pre-commit checks before committing:

  pre-commit run --all-files

✨ Commit Messages (Gitmoji Style)

We follow Gitmoji for structured commit messages. Each commit should start with an emoji that represents the change type. Example:

git commit -m "✨ Add new feature"

📜 Submitting a Pull Request

1. Push your branch to your fork:

   git push origin feature-or-bugfix-name

2. Open a Pull Request (PR) on GitHub:

   • Provide a clear title and description.
   • Link any relevant issue (if applicable).
   • Request a review from maintainers.