Configuration Examples

This directory contains real-world examples of codebase validation configurations for different project types and team requirements.

Available Examples

Project Types

• Beginner-Friendly - Perfect starting point for new developers
• Basic Configuration - Simple setup for small projects
• Go Project - Complete Go project configuration
• Open Source - Configuration for open source projects
• Strict Standards - High validation standards for professional teams
• Node.js Project - JavaScript/TypeScript project setup (coming soon)
• Python Project - Python package configuration (coming soon)
• Enterprise Setup - Large organization standards (coming soon)

Team Configurations

• Strict Standards - High validation standards
• Lenient Standards - Relaxed validation for legacy projects
• CI/CD Optimized - Configuration optimized for automated pipelines

Special Cases

• Open Source - Configuration for open source projects
• Legacy Migration - Gradual migration from legacy codebases
• Multi-Language - Projects with multiple programming languages

Usage

Copy any example configuration to your project root as .codebase-validation.yml and customize as needed:

# Copy basic configuration
cp docs/examples/basic.yml .codebase-validation.yml

# Copy and customize for your project
cp docs/examples/go-project.yml .codebase-validation.yml

Contributing Examples

To contribute a new example configuration:

1. Create a new .yml file in this directory
2. Follow the naming convention: descriptive-name.yml
3. Include comprehensive comments explaining the configuration choices
4. Add an entry to this README with a brief description
5. Test the configuration on a real project

Example Structure

Each example should include:

# Brief description of the use case
# Target project type or team size
# Key features enabled/disabled

validation:
  agents:
    # Agent configurations with comments

  output:
    # Output preferences

  custom:
    # Any custom settings