.coderabbit.yaml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

# =============================================================================
# General
# =============================================================================
language: en-US
tone_instructions: >-
  Be direct and concise. Focus on why, not just what.
  This is a Python CLI tool that assesses repositories for AI-assisted development readiness.
early_access: false
enable_free_tier: false

# =============================================================================
# Reviews
# =============================================================================
reviews:
  profile: assertive
  request_changes_workflow: true
  high_level_summary: true
  review_status: true
  collapse_walkthrough: true
  changed_files_summary: true
  sequence_diagrams: true
  assess_linked_issues: true
  related_issues: true
  related_prs: true
  suggested_labels: true
  suggested_reviewers: false
  in_progress_fortune: false
  poem: false
  commit_status: false
  estimate_code_review_effort: false

  slop_detection:
    enabled: true

  # ---------------------------------------------------------------------------
  # Path filters
  # ---------------------------------------------------------------------------
  path_filters:
    - "!**/*.pyc"
    - "!**/__pycache__/**"
    - "!.venv/**"
    - "!venv/**"
    - "!htmlcov/**"
    - "!.pytest_cache/**"
    - "!.ruff_cache/**"
    - "!*.egg-info/**"
    - "!build/**"
    - "!dist/**"
    - "!.agentready/**"
    - "!.cache/**"
    - "!*.log"
    - "!*.tmp"
    - "!uv.lock"
    - "!poetry.lock"
    - "!package-lock.json"
    - "!examples/**/*.json"
    - "!examples/**/*.html"
    - "!examples/**/*.md"

  # ---------------------------------------------------------------------------
  # Path instructions
  # ---------------------------------------------------------------------------
  path_instructions:
    - path: "**/*"
      instructions: |
        - Prioritize Critical and Major severity issues. Minimize Minor and Trivial findings.
        - Flag bugs, security vulnerabilities, logic errors, and meaningful refactoring opportunities.
        - No pure style or formatting suggestions (black/ruff handle this).
        - Limit to 3-5 comments max; group similar issues; mention repeated patterns once.
        - If nothing is broken, approve briefly.

    - path: "src/agentready/assessors/**"
      instructions: |
        - Verify BaseAssessor pattern compliance.
        - Check for proper error handling (return skipped/error Finding, don't crash).
        - Ensure proportional scoring using calculate_proportional_score().
        - Check for graceful degradation when tools missing.

    - path: "src/agentready/models/**"
      instructions: |
        - Check for breaking changes to data models.
        - Verify backwards compatibility.
        - Ensure schema version bumps when needed.

    - path: "src/agentready/services/**"
      instructions: |
        - Check for proper error handling.
        - Verify performance implications (file I/O, subprocess calls).
        - Look for security issues (path traversal, command injection).

    - path: "src/agentready/cli/**"
      instructions: |
        - Check for clear error messages.
        - Verify help text is accurate.
        - Look for missing error handling for user input.

    - path: "tests/**"
      instructions: |
        - Verify test actually tests the intended behavior.
        - Check for missing edge cases.
        - Flag overly brittle tests (mocking too much).
        - Skip all style comments.

    - path: ".github/workflows/**/*.{yml,yaml}"
      instructions: |
        - Pin action versions to SHA. Verify secrets are not exposed and permissions are scoped.

    - path: "scripts/**"
      instructions: |
        - Check for command injection vulnerabilities.
        - Verify error handling for subprocess calls.
        - Flag missing input validation.

  # ---------------------------------------------------------------------------
  # Auto review
  # ---------------------------------------------------------------------------
  auto_review:
    enabled: true
    drafts: false
    ignore_title_keywords:
      - "WIP"
      - "DO NOT MERGE"
    ignore_usernames:
      - "dependabot[bot]"
      - "renovate[bot]"
    base_branches:
      - "main"

  # ---------------------------------------------------------------------------
  # Finishing touches
  # ---------------------------------------------------------------------------
  finishing_touches:
    docstrings:
      enabled: true
    unit_tests:
      enabled: true
    simplify:
      enabled: true

  # ---------------------------------------------------------------------------
  # Pre-merge checks
  # ---------------------------------------------------------------------------
  pre_merge_checks:
    docstrings:
      mode: warning
      threshold: 80

    title:
      mode: warning
      requirements: >-
        Conventional Commits format: type(scope): description.
        Types: feat, fix, chore, docs, refactor, test, ci, perf.

    description:
      mode: warning

    issue_assessment:
      mode: warning

  # ---------------------------------------------------------------------------
  # Tools
  # ---------------------------------------------------------------------------
  tools:
    ruff:
      enabled: true
    flake8:
      enabled: false
    pylint:
      enabled: false

    # Not applicable to this project
    biome:
      enabled: false
    oxc:
      enabled: false
    golangci-lint:
      enabled: false
    buf:
      enabled: false
    checkmake:
      enabled: false

    # Enabled
    actionlint:
      enabled: true
    shellcheck:
      enabled: true
    yamllint:
      enabled: true
    markdownlint:
      enabled: true
    gitleaks:
      enabled: true
    trufflehog:
      enabled: true
    github-checks:
      enabled: true
      timeout_ms: 90000
    hadolint:
      enabled: true

# =============================================================================
# Chat
# =============================================================================
chat:
  auto_reply: false
  art: false

# =============================================================================
# Knowledge base
# =============================================================================
knowledge_base:
  opt_out: false
  web_search:
    enabled: false
  code_guidelines:
    enabled: true
  learnings:
    scope: global
  issues:
    scope: auto
  pull_requests:
    scope: auto