66 lines (47 loc) · 1.65 KB

Contributing to AIRun

Thank you for your interest in contributing to AIRun! This document provides guidelines and instructions for contributing.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

A clear, descriptive title
Steps to reproduce the bug
Expected behavior
Actual behavior
Your operating system and Rust version

Suggesting Features

Feature suggestions are welcome! Please open an issue with:

A clear, descriptive title
A detailed description of the proposed feature
Any relevant examples or use cases

Adding New AI Tools

To add support for a new AI tool, edit src/main.rs and add a new AiTool entry to the TOOLS array:

AiTool {
    name: "Tool Name",
    command: "tool-command",
    description: "Brief description of the tool",
},

The tool will be automatically detected if the command is available in the user's PATH.

Pull Requests

Fork the repository
Create a feature branch (git checkout -b feature/your-feature)
Make your changes
Test your changes (cargo test if tests exist, or manual testing)
Commit your changes (git commit -m "Add your feature")
Push to your branch (git push origin feature/your-feature)
Open a pull request

Code Style

Follow standard Rust conventions (cargo fmt)
Ensure code compiles without warnings (cargo clippy)
Add comments where appropriate
Keep the codebase simple and readable

Development Setup

git clone https://github.com/ThomasNowProductions/AIRun
cd AIRun
cargo build

Questions?

Feel free to open an issue for any questions or clarifications.

Thank you for contributing!