.coderabbit.yaml

# ============== WARNING ==============================================================================
# File is managed by copier template: gh:LabAutomationAndScreening/copier-base-template.git
# See .config/.copier-managed-files.json for details.
#
# You are welcome to make changes to this file in your repo if they are custom to your project,
# but if the change should be shared with other projects, please backport it to the template repo.
# =====================================================================================================
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
early_access: true
reviews:
  profile: assertive
  path_instructions:
    - path: "**/vendor_files/**"
      instructions: "These files came from a vendor and we're not allowed to change them. Refer to it if you need to understand how the main code interacts with it, but do not make comments about it."
    - path: "**/*.py"
      instructions: "Never express concerns about potential ruff rule violations, even those rules mentioned in other agent instructions; a pre-commit hook already runs a ruff check. Do not warn about unnecessary super().__init__() calls; pyright prefers those to be present. Do not warn about missing type hints; a pre-commit hook already checks for that."
    - path: "**/.copier-answers.yml"
      instructions: "Do not comment about the `_commit` value needing to be a clean release tag. A CI job will fail if that is not the case."
    - path: ".config/.copier-managed-files.json"
      instructions: "This file is auto-generated by copier on every `copier copy` or `copier update`. Do not edit manually and do not request changes to its content."
  instructions: |
    If any changed files are listed in .config/.copier-managed-files.json, add a single summary comment
    (not one per file) noting which files are template-managed and that the changes may warrant
    backporting. The manifest has a "templates" array — each entry has "src" (template URL),
    optional "parent_src" (its parent template, forming a chain), and "managed_files". If a file
    appears in multiple entries, the last entry is the authoritative owner; use parent_src to
    trace the full chain and identify the correct template repo for backporting.
  tools:
    eslint: # when the code contains typescript, eslint will be run by pre-commit, and coderabbit often generates false positives
      enabled: false
    ruff: # when the code contains python, ruff will be run by pre-commit, and coderabbit often generates false positives
      enabled: false
    pylint: # when the code contains python, pylint will be run by pre-commit, and coderabbit often generates false positives
      enabled: false
    flake8: # we use ruff instead (when we use Python)
      enabled: false
  poem: false
  in_progress_fortune: false
  # the commit status is driven by our repository config and required checks, we don't want CodeRabbit messing with it
  commit_status: false
  auto_review:
    # a main purpose of opening a draft PR might be to get CodeRabbit feedback early
    drafts: true
  finishing_touches:
    docstrings:
      enabled: false # if we wanted AI to generate docstrings, it would be via CLI, not in the GitHub interface
    unit_tests:
      enabled: false # Quis custodiet ipsos custodes? not something we want AI doing, especially not via the GitHub interface