Contributing to CLIAI

Thank you for your interest in contributing to CLIAI! We welcome contributions from the community and are excited to see what you'll bring to the project.

🚀 Getting Started

Prerequisites

Rust 1.70 or later
Git
Ollama (for testing AI functionality)

Development Setup

Fork and Clone

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

Install Dependencies
```
cargo build
```

Set up Ollama (for testing)

# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a test model
ollama pull mistral

Run Tests

# Unit tests
cargo test

# Integration tests with AI
cargo run -- test --quick

🎯 How to Contribute

Reporting Issues

Use the GitHub Issues page
Search existing issues before creating a new one
Include detailed reproduction steps
Provide system information (OS, Rust version, etc.)

Suggesting Features

Open a GitHub Discussion first
Describe the use case and expected behavior
Consider implementation complexity and maintenance burden

Code Contributions

Create a Feature Branch

git checkout -b feature/your-feature-name

Make Your Changes
- Follow the existing code style
- Add tests for new functionality
- Update documentation as needed

Test Your Changes

# Run all tests
cargo test

# Test with real AI (requires Ollama)
cargo run -- test --categories "your-test-category"

# Check formatting
cargo fmt --check

# Run clippy
cargo clippy -- -D warnings

Commit Your Changes

git add .
git commit -m "feat: add amazing new feature"

Push and Create PR

git push origin feature/your-feature-name

📝 Code Style Guidelines

Rust Code Style

Use cargo fmt for consistent formatting
Follow Rust naming conventions
Add documentation comments for public APIs
Use clippy suggestions to improve code quality

Commit Messages

We follow the Conventional Commits specification:

feat: - New features
fix: - Bug fixes
docs: - Documentation changes
style: - Code style changes (formatting, etc.)
refactor: - Code refactoring
test: - Adding or updating tests
chore: - Maintenance tasks

Examples:

feat: add support for custom AI providers
fix: resolve command validation edge case
docs: update installation instructions
test: add integration tests for file operations

🏗️ Project Structure

Understanding the codebase:

src/
├── src/
│   ├── main.rs              # CLI interface and entry point
│   ├── lib.rs               # Library exports
│   ├── agents/              # AI orchestration
│   │   ├── mod.rs           # Main orchestrator
│   │   └── profiles.rs      # AI model profiles
│   ├── config.rs            # Configuration management
│   ├── context.rs           # System context gathering
│   ├── execution.rs         # Command execution
│   ├── validation.rs        # Command validation
│   ├── providers.rs         # AI provider implementations
│   ├── history.rs           # Chat history
│   ├── performance.rs       # Performance monitoring
│   ├── error_handling.rs    # Error handling
│   ├── logging.rs           # Privacy-preserving logging
│   └── test_suite.rs        # Testing framework
├── Cargo.toml               # Dependencies and metadata
├── README.md                # Project documentation
└── CONTRIBUTING.md          # This file

🧪 Testing Guidelines

Unit Tests

Write tests for all public functions
Use descriptive test names
Test both success and error cases
Mock external dependencies when possible

#![allow(unused)]
fn main() {
#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_command_validation_success() {
        // Test implementation
    }
    
    #[test]
    fn test_command_validation_failure() {
        // Test implementation
    }
}
}