Welcome! We appreciate your interest in contributing to the project. This document outlines our contribution guidelines.
• First, read Development Setup for environment configuration and known issues. • Check our Testing Guide for how to run tests. • See Configuration Schema for environment variables and project settings.
- Fork the repo
- Create a branch for your changes
- Commit with clear messages
- Open a Pull Request against the main branch
- Ensure your PR includes tests if relevant
- Reference any open issues by ID in your PR description
• Rust code should follow rustfmt conventions and Clippy suggestions. • Write descriptive commit messages.
• Please update or add documentation for features or changes. • Some docs might contain placeholders (like Tools API was incomplete), but we’re in the process of improving them. Feel free to contribute expansions. • The same goes for the config schema. If you add new config keys or environment variables, update config-schema.md.
• If you find a bug, please open a GitHub issue. • Provide as much detail as possible—OS, Rust version, logs, steps to reproduce, etc.
• Security Model – discusses how the project handles sandboxing and permissions. • Architecture Overview – high-level design of crates.
We value every contribution, from filing issues to resolving them. Let’s build a robust, secure, and user-friendly system together!
End of Contributing Guide