CONTRIBUTING.md

Contributing

Thank you for your interest in contributing to this project!

Development

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes using conventional commits
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

Commit Convention

This project uses Conventional Commits. Please format your commit messages as:

<type>: <description>

[optional body]

Examples:

• feat: add user authentication
• fix: resolve memory leak in worker process
• docs: update API documentation

Changelog

The changelog is automatically generated using git-cliff. To update the changelog:

git-cliff --output CHANGELOG.md

The changelog follows the Keep a Changelog format and includes GitHub integration for PR links and contributor recognition.

License

This project uses SPDX headers for license compliance. You should add appropriate SPDX headers to all your source files.

We have a script to automatically add SPDX headers based on git blame data:

python3 scripts/add-spdx-attribution.py --file path/to/file.rs

Before submitting your changes, verify SPDX compliance using the REUSE tool:

reuse lint