Contributing Guide
July 31, 2026 ยท View on GitHub
Welcoming contributions from the community!
Quick Start
- Fork and clone the repository:
git clone https://github.com/yourusername/feluda.git
cd feluda
- Build and run:
cargo build
./target/debug/feluda --help
- Run tests:
cargo test
- Setup pre-commit hooks (recommended):
just setup
Documentation
For detailed contributing guidelines, please visit our documentation:
- Development Setup - Complete setup instructions
- Testing Guide - Running tests and example projects
- Architecture - Codebase structure and design
- Adding Languages - How to add support for new languages
- License Matrix - Maintaining the compatibility matrix
Submitting Changes
- Create a branch:
git checkout -b feat/my-feature - Make your changes and commit:
git commit -m "add: feature" - Push and open a PR:
git push origin feat/my-feature
Reporting Issues
Found a bug or have a feature request? Open an issue on GitHub.
Minimum Supported Rust Version: 1.88.0