Compass/.coderabbit.yaml at main · CompassConnections/Compass · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# Enables IDE autocompletion for this config file
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

# Language for CodeRabbit's review comments
language: en

# Enable experimental features (currently not using any specific early_access features)
early_access: true

chat:
  # CodeRabbit will automatically respond to @coderabbitai mentions in PR comments
  auto_reply: true

reviews:
  auto_review:
    # Automatically trigger reviews when PRs are opened or updated
    enabled: true
    # Skip auto-review if PR title contains these keywords
    ignore_title_keywords:
      - 'WIP'
    # Don't auto-review draft PRs
    drafts: false
    # Only auto-review PRs targeting these branches
    base_branches:
      - main
      - develop

  # Include a high-level summary at the start of each review
  high_level_summary: true

  # Generate sequence diagrams for complex code flows
  sequence_diagrams: true

  # Don't include poems in reviews (fun feature, but keeping it professional)
  poem: false

  # Show review completion status
  review_status: true

  # Keep the walkthrough section expanded by default
  collapse_walkthrough: false

  # Include summary of all changed files
  changed_files_summary: true

  # Don't automatically request changes on the PR (just leave comments)
  request_changes_workflow: false

  # Pre-merge checks to enforce before merging PRs
  pre_merge_checks:
    description:
      # Validate that PR has a proper description
      mode: warning # Options: off, warning, error
    docstrings:
      # Disable docstring coverage checks (let's assume we don't need them)
      mode: off

  # Exclude these paths from reviews (build artifacts and dependencies)
  path_filters:
    - '!**/node_modules/**' # npm dependencies
    - '!**/android/**' # Native Android build files
    - '!**/ios/**' # Native iOS build files
    - '!**/.expo/**' # Expo build cache
    - '!**/.expo-shared/**' # Expo shared config
    - '!**/dist/**' # Build output

  # Custom review instructions for specific file patterns
  path_instructions:
    # TypeScript/JavaScript files - main app code
    - path: '**/*.{ts,tsx,js,jsx}'
      instructions: |
        General practices:
        - Summarize the changes clearly.
        - Format the summary with bullet points.
        - Highlight any potential breaking changes for users.
        - We use early returns to avoid deep nesting.
        - Ensure all public functions have docstrings.
        - Flag any hardcoded strings; they should be in the constants file.
        - Check for edge cases like null values or empty arrays.
        - Suggest performance optimizations where appropriate.

        Mobile best practices:
        - Proper use of hooks (useRouter, useFonts, useAssets)
        - Accessibility: touch targets min 44x44, screen reader support
        - Safe area handling and platform-specific code (iOS vs Android)
        - Memory leaks in useEffect and event listeners

        Performance:
        - Use FlatList/SectionList for lists (never ScrollView with .map)
        - React.memo, useMemo, useCallback where appropriate

        TypeScript:
        - Avoid 'any', use explicit types
        - Prefer 'import type' for type imports

        Security:
        - No exposed API keys or sensitive data
        - Use expo-secure-store for sensitive storage
        - Validate deep linking configurations

        Internationalization:
        - User-visible strings should be externalized to JSON resource files in common/messages via
          ```
          const t = useT()
          const message = t('key', 'english string')
          ```

    - path: 'tests/e2e/**/*.ts'
      instructions: |
        Playwright E2E test guidelines for this repo:
        - Page objects live in `tests/e2e/web/pages/`. Each class wraps one page/route, holds only `private readonly` Locators, and exposes action methods.
        - All tests must use the `app` fixture (type `App`) from `tests/e2e/web/fixtures/base.ts`. Never instantiate page objects directly in a test.
        - Cross-page flows (actions spanning multiple pages) belong as methods on the `App` class, not as standalone helper functions.
        - Action methods in page objects must assert `expect(locator).toBeVisible()` before interacting.
        - Never use `page.waitForTimeout()`. Use Playwright's built-in auto-waiting or `waitForURL` / `waitForSelector`.
        - No hardcoded credentials in spec files; use `SPEC_CONFIG.ts` or account fixtures.
        - Test account cleanup must be done in fixture teardown (after `await use(...)`), not in `afterEach` hooks.
        - File and class names must use PascalCase (e.g., `CompatibilityPage.ts` / `class CompatibilityPage`).
        - No DB or Firebase calls inside page object classes; those belong in `tests/e2e/utils/`.
        - Flag any new page object not yet registered in `App`.