joplin/.coderabbit.yaml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-GB"
reviews:
  high_level_summary: false
  estimate_code_review_effort: false
  poem: false
  auto_review:
    enabled: true
    drafts: false
    ignore_usernames:
      - "renovate[bot]"
  auto_apply_labels: true
  labeling_instructions:
    - label: "accessibility"
      instructions: "Apply when the PR contains changes related to accessibility, screen readers, keyboard navigation, or ARIA attributes."
    - label: "android"
      instructions: "Apply when the PR contains changes specific to the Android platform or Android app."
    - label: "api"
      instructions: "Apply when the PR modifies the Joplin API, REST endpoints, or API-related code."
    - label: "bug"
      instructions: "Apply when the PR fixes a bug or unexpected behaviour."
    - label: "ci"
      instructions: "Apply when the PR modifies CI/CD configuration, GitHub Actions workflows, or build pipelines."
    - label: "cli"
      instructions: "Apply when the PR contains changes specific to the Joplin CLI (command-line) application."
    - label: "clipper"
      instructions: "Apply when the PR contains changes to the Joplin Web Clipper browser extension."
    - label: "database"
      instructions: "Apply when the PR modifies database schema, migrations, or database-related logic."
    - label: "desktop"
      instructions: "Apply when the PR contains changes specific to the Joplin desktop (Electron) application."
    - label: "documentation"
      instructions: "Apply when the PR adds or updates documentation, README files, or code comments."
    - label: "draw"
      instructions: "Apply when the PR contains changes related to the drawing or sketching feature."
    - label: "editor"
      instructions: "Apply when the PR contains changes to the note editor (CodeMirror, TinyMCE, or the editor infrastructure)."
    - label: "enhancement"
      instructions: "Apply when the PR adds a new feature or improves existing functionality (not a bug fix)."
    - label: "export"
      instructions: "Apply when the PR contains changes to export functionality (PDF, HTML, JEX, etc.)."
    - label: "import"
      instructions: "Apply when the PR contains changes to import functionality (Evernote, Markdown, etc.)."
    - label: "iOS"
      instructions: "Apply when the PR contains changes specific to the iOS platform or iOS app."
    - label: "linux"
      instructions: "Apply when the PR contains changes specific to Linux."
    - label: "linux/wayland"
      instructions: "Apply when the PR contains changes specific to Linux Wayland."
    - label: "macOS"
      instructions: "Apply when the PR contains changes specific to macOS."
    - label: "markdown-editor"
      instructions: "Apply when the PR contains changes to the Markdown editor or Markdown rendering."
    - label: "mobile"
      instructions: "Apply when the PR contains changes to the mobile app (iOS or Android)."
    - label: "multi-window"
      instructions: "Apply when the PR contains changes related to multi-window support."
    - label: "OCR"
      instructions: "Apply when the PR contains changes related to OCR (optical character recognition) functionality."
    - label: "performance"
      instructions: "Apply when the PR improves performance, reduces memory usage, or optimises speed."
    - label: "plugins"
      instructions: "Apply when the PR contains changes to the plugin system, plugin API, or specific plugins."
    - label: "Regression"
      instructions: "Apply when the linked issue, if any, has the Regression label."
    - label: "renderer"
      instructions: "Apply when the PR contains changes to the note renderer or how notes are displayed."
    - label: "search"
      instructions: "Apply when the PR contains changes to search functionality."
    - label: "security"
      instructions: "Apply when the PR addresses a security vulnerability or improves security."
    - label: "server"
      instructions: "Apply when the PR contains changes to Joplin Server."
    - label: "Sharing"
      instructions: "Apply when the PR contains changes to note or notebook sharing features."
    - label: "sync"
      instructions: "Apply when the PR contains changes to synchronisation logic or sync targets."
    - label: "tags"
      instructions: "Apply when the PR contains changes to tag management or tagging functionality."
    - label: "transcribe"
      instructions: "Apply when the PR contains changes to audio transcription functionality."
    - label: "translation"
      instructions: "Apply when the PR adds or updates translations or localisation strings."
    - label: "Voice typing"
      instructions: "Apply when the PR contains changes to voice typing functionality."
    - label: "web"
      instructions: "Apply when the PR contains changes to the Joplin web application or web-related features."
    - label: "windows"
      instructions: "Apply when the PR contains changes specific to Windows."
knowledge_base:
  code_guidelines:
    enabled: true
    filePatterns:
      - "readme/dev/coding_style.md"
      - "readme/dev/index.md"