Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python
5.5 KB
Raw Blame
language: en-US
tone_instructions: ""
early_access: true
enable_free_tier: true
reviews:
  profile: chill
  request_changes_workflow: false
  high_level_summary: true
  high_level_summary_placeholder: "@coderabbitai summary"
  high_level_summary_in_walkthrough: false
  auto_title_placeholder: "@coderabbitai"
  auto_title_instructions: Use conventional commits structure
  review_status: true
  commit_status: true
  fail_commit_status: false
  collapse_walkthrough: false
  changed_files_summary: true
  sequence_diagrams: true
  assess_linked_issues: true
  related_issues: true
  related_prs: true
  suggested_labels: true
  auto_apply_labels: false
  suggested_reviewers: true
  auto_assign_reviewers: false
  poem: false
  labeling_instructions:
    - label: "enhancement"
      instructions: "Apply when the PR adds new features or capabilities."
    - label: "bug"
      instructions: "Apply when the PR fixes a defect or regression."
    - label: "documentation"
      instructions: "Apply when the PR only changes docs, README, AGENTS.md, or CLAUDE.md."
    - label: "refactor"
      instructions: "Apply when the PR restructures existing code without changing behaviour."
    - label: "tests"
      instructions: "Apply when the PR only adds or updates tests."
  path_filters: []
  path_instructions:
    - path: "src/**/*.py"
      instructions: "Use get_logger from utils.logging_config — never import stdlib logging directly. Config values must come from config/settings.py (the only place os.environ is read); never access os.environ elsewhere in the codebase."
    - path: "src/api/**/*.py"
      instructions: "FastAPI routes. Public/stable endpoints belong under src/api/v1/. Verify dependency injection via src/dependencies.py, response model typing, and correct HTTP status codes. No business logic in route handlers."
    - path: "src/connectors/**/*.py"
      instructions: "External data connectors (Google Drive, OneDrive, S3, IBM COS). New connectors must subclass connectors/base.py and register through connectors/service.py. Verify credentials are never logged, errors surface cleanly, and pagination is handled correctly."
    - path: "src/services/**/*.py"
      instructions: "Business logic layer. New services must be instantiated in the lifespan block in main.py and injected into routers via src/dependencies.py — never instantiated directly in route handlers."
    - path: "frontend/**"
      instructions: "Next.js App Router with React 19. Lint and format via Biome — not ESLint. State management via Zustand (stores/) and React Query for server state. UI built on Radix primitives + Tailwind."
    - path: "kubernetes/operator/**/*.go"
      instructions: "Kubernetes controller using controller-runtime. Check for proper reconciliation loop patterns, status condition updates, and RBAC annotations on new resources."
  abort_on_close: true
  disable_cache: false
  auto_review:
    enabled: true
    auto_incremental_review: true
    ignore_title_keywords: []
    labels: []
    drafts: false
  finishing_touches:
    docstrings:
      enabled: true
    unit_tests:
      enabled: true
  tools:
    ast-grep:
      rule_dirs: []
      util_dirs: []
      essential_rules: true
      packages: []
    shellcheck:
      enabled: true
    ruff:
      enabled: true
    markdownlint:
      enabled: true
    github-checks:
      enabled: true
      timeout_ms: 90000
    languagetool:
      enabled: true
      enabled_rules: []
      disabled_rules: []
      enabled_categories: []
      disabled_categories: []
      enabled_only: false
      level: default
    biome:
      enabled: true
    hadolint:
      enabled: true
    swiftlint:
      enabled: false
    phpstan:
      enabled: false
    golangci-lint:
      enabled: true
    yamllint:
      enabled: true
    gitleaks:
      enabled: true
    checkov:
      enabled: true
    detekt:
      enabled: false
    eslint:
      enabled: false
    rubocop:
      enabled: false
    buf:
      enabled: false
    regal:
      enabled: false
    actionlint:
      enabled: true
    pmd:
      enabled: false
    cppcheck:
      enabled: false
    semgrep:
      enabled: true
    circleci:
      enabled: false
    clippy:
      enabled: false
    sqlfluff:
      enabled: false
    prismaLint:
      enabled: false
    pylint:
      enabled: true
    oxc:
      enabled: true
    shopifyThemeCheck:
      enabled: false
    luacheck:
      enabled: false
    brakeman:
      enabled: false
    dotenvLint:
      enabled: true
    htmlhint:
      enabled: true
    checkmake:
      enabled: true
chat:
  auto_reply: true
  integrations:
    jira:
      usage: auto
    linear:
      usage: auto
issue_enrichment:
  auto_enrich:
    enabled: true
  planning:
    enabled: true
    auto_planning:
      enabled: true
      labels:
        - "enhancement"
        - "bug"
        - "refactor"
        - "!documentation"
        - "!tests"
knowledge_base:
  opt_out: false
  code_guidelines:
    enabled: true
  web_search:
    enabled: true
  learnings:
    scope: auto
  issues:
    scope: auto
  jira:
    usage: auto
    project_keys: []
  linear:
    usage: auto
    team_keys: []
  pull_requests:
    scope: auto
code_generation:
  docstrings:
    language: en-US
    path_instructions: []
  unit_tests:
    path_instructions:
      - path: "tests/**/*.py"
        instructions: Use pytest with pytest-asyncio for async tests. Fixtures are defined in tests/conftest.py and tests/unit/conftest.py.
      - path: "frontend/tests/**/*.ts"
        instructions: Use Playwright. Test files use the .spec.ts extension.