CONTRIBUTING.md

Contributing Guide

Welcoming contributions from the community!

Quick Start

1. Fork and clone the repository:

git clone https://github.com/yourusername/feluda.git
cd feluda

2. Build and run:

cargo build
./target/debug/feluda --help

3. Run tests:

cargo test

4. 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

1. Create a branch: git checkout -b feat/my-feature
2. Make your changes and commit: git commit -m "add: feature"
3. 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