PictoPy/.coderabbit.yaml at main · AOSSIE-Org/PictoPy · 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# 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
early_access: true

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

issue_enrichment:
    labeling:
        auto_apply_labels: true
        labeling_instructions:
            - label: bug
              instructions: Issues reporting bugs, errors, crashes, incorrect behavior, or unexpected results.
            - label: enhancement
              instructions: Feature requests, improvements to existing functionality, performance optimizations, refactoring suggestions, UI/UX enhancements.
            - label: documentation
              instructions: Documentation updates, additions, corrections, or clarifications needed.
    planning:
        enabled: true
        auto_planning:
            enabled: true
            labels:
                - 'plan-me'
                - 'feature'
                - '!no-plan'

reviews:
    profile: chill # Options: chill, assertive

    auto_review:
        enabled: true
        ignore_title_keywords:
            - 'WIP'
        drafts: false
        base_branches:
            - develop

    high_level_summary: true
    sequence_diagrams: true
    poem: true
    review_status: true
    collapse_walkthrough: false
    changed_files_summary: true
    request_changes_workflow: true

    pre_merge_checks:
        description:
            mode: warning
        docstrings:
            mode: off

    path_filters:
        - '!**/node_modules/**'
        - '!**/dist/**'
        - '!**/build/**'
        - '!**/__pycache__/**'
        - '!**/.venv/**'

    tools:
        ruff:
            enabled: true
        markdownlint:
            enabled: true
        github-checks:
            enabled: true
            timeout_ms: 90000
        eslint:
            enabled: true
        biome:
            enabled: true
        yamllint:
            enabled: true
        gitleaks:
            enabled: true
        clippy:
            enabled: true

    labeling_instructions:
        - label: Python
          instructions: Apply when the PR/MR contains changes to python source-code
        - label: TypeScript/JavaScript
          instructions: Apply when the PR/MR contains changes to javascript or typescript source-code
        - label: Rust
          instructions: Apply when the PR/MR contains changes to Rust source-code (Tauri backend)
        - label: Documentation
          instructions: Apply whenever project documentation is updated by the PR/MR
        - label: Linter
          instructions: Apply when the purpose of the PR/MR is related to fixing the feedback from a linter

    path_instructions:
        # Catch-all general instructions that apply to all files
        - path: '**/*'
          instructions: |
              - Verify that documentation and comments are free of spelling mistakes
              - Ensure that test code is automated, comprehensive, and follows testing best practices
              - Verify that all critical functionality is covered by tests
              - Confirm that the code meets the project's requirements and objectives
              - Point out redundant obvious comments that do not add clarity to the code
              - Look for code duplication
              - Suggest code completions when seeing a TODO or FIXME comment

        # TypeScript/JavaScript/React files (Vite Frontend)
        - path: '**/*.{ts,tsx,js,jsx}'
          instructions: |
              TypeScript & React:
              - Avoid 'any', use explicit types.
              - The code adheres to best practices associated with React and Vite.
              - Ensure responsive design principles are followed.
              - Check for proper React hook dependencies and prevent unnecessary re-renders.

        # Rust files (Tauri Backend)
        - path: '**/src-tauri/**/*.rs'
          instructions: |
              Rust (Tauri):
              - Ensure idiomatic Rust code is written.
              - Watch out for unnecessary clone() calls or inefficient memory usage.
              - Ensure errors are handled properly using Result rather than unwrap() or expect().
              - Ensure Tauri commands are safely exposed to the frontend.

        # Python files (Backend Microservices)
        - path: '**/*.py'
          instructions: |
              Python:
              - Check for PEP 8 violations and Python best practices.
              - Check for performance considerations in asynchronous code.
              - Ensure proper use of type hints.

        # CSS/SCSS files
        - path: '**/*.{css,scss}'
          instructions: |
              CSS & Styling:
              - The code adheres to best practices associated with CSS.
              - Look for responsive design issues.

        # Asset files
        - path: '**/assets/**/*'
          instructions: |
              Assets:
              - Check image optimization and proper formats (WebP, SVG).