|
| 1 | +# Enables IDE autocompletion for this config file |
| 2 | +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json |
| 3 | + |
| 4 | +# Language for CodeRabbit's review comments |
| 5 | +language: en |
| 6 | + |
| 7 | +# Enable experimental features |
| 8 | +early_access: true |
| 9 | + |
| 10 | +chat: |
| 11 | + # CodeRabbit will automatically respond to @coderabbitai mentions in PR comments |
| 12 | + auto_reply: true |
| 13 | + |
| 14 | +issue_enrichment: |
| 15 | + labeling: |
| 16 | + auto_apply_labels: true |
| 17 | + labeling_instructions: |
| 18 | + - label: bug |
| 19 | + instructions: Issues reporting bugs, errors, crashes, incorrect behavior, or unexpected results. |
| 20 | + - label: enhancement |
| 21 | + instructions: Feature requests, improvements to existing functionality, performance optimizations, refactoring suggestions, UI/UX enhancements. |
| 22 | + - label: documentation |
| 23 | + instructions: Documentation updates, additions, corrections, or clarifications needed. |
| 24 | + planning: |
| 25 | + enabled: true |
| 26 | + auto_planning: |
| 27 | + enabled: true |
| 28 | + labels: |
| 29 | + - 'plan-me' |
| 30 | + - 'feature' |
| 31 | + - '!no-plan' |
| 32 | + |
| 33 | +reviews: |
| 34 | + profile: chill # Options: chill, assertive |
| 35 | + |
| 36 | + auto_review: |
| 37 | + enabled: true |
| 38 | + ignore_title_keywords: |
| 39 | + - 'WIP' |
| 40 | + drafts: false |
| 41 | + base_branches: |
| 42 | + - develop |
| 43 | + |
| 44 | + high_level_summary: true |
| 45 | + sequence_diagrams: true |
| 46 | + poem: true |
| 47 | + review_status: true |
| 48 | + collapse_walkthrough: false |
| 49 | + changed_files_summary: true |
| 50 | + request_changes_workflow: true |
| 51 | + |
| 52 | + pre_merge_checks: |
| 53 | + description: |
| 54 | + mode: warning |
| 55 | + docstrings: |
| 56 | + mode: off |
| 57 | + |
| 58 | + path_filters: |
| 59 | + - '!**/node_modules/**' |
| 60 | + - '!**/dist/**' |
| 61 | + - '!**/build/**' |
| 62 | + - '!**/__pycache__/**' |
| 63 | + - '!**/.venv/**' |
| 64 | + |
| 65 | + tools: |
| 66 | + ruff: |
| 67 | + enabled: true |
| 68 | + markdownlint: |
| 69 | + enabled: true |
| 70 | + github-checks: |
| 71 | + enabled: true |
| 72 | + timeout_ms: 90000 |
| 73 | + eslint: |
| 74 | + enabled: true |
| 75 | + biome: |
| 76 | + enabled: true |
| 77 | + yamllint: |
| 78 | + enabled: true |
| 79 | + gitleaks: |
| 80 | + enabled: true |
| 81 | + clippy: |
| 82 | + enabled: true |
| 83 | + |
| 84 | + labeling_instructions: |
| 85 | + - label: Python |
| 86 | + instructions: Apply when the PR/MR contains changes to python source-code |
| 87 | + - label: TypeScript/JavaScript |
| 88 | + instructions: Apply when the PR/MR contains changes to javascript or typescript source-code |
| 89 | + - label: Rust |
| 90 | + instructions: Apply when the PR/MR contains changes to Rust source-code (Tauri backend) |
| 91 | + - label: Documentation |
| 92 | + instructions: Apply whenever project documentation is updated by the PR/MR |
| 93 | + - label: Linter |
| 94 | + instructions: Apply when the purpose of the PR/MR is related to fixing the feedback from a linter |
| 95 | + |
| 96 | + path_instructions: |
| 97 | + # Catch-all general instructions that apply to all files |
| 98 | + - path: '**/*' |
| 99 | + instructions: | |
| 100 | + - Verify that documentation and comments are free of spelling mistakes |
| 101 | + - Ensure that test code is automated, comprehensive, and follows testing best practices |
| 102 | + - Verify that all critical functionality is covered by tests |
| 103 | + - Confirm that the code meets the project's requirements and objectives |
| 104 | + - Point out redundant obvious comments that do not add clarity to the code |
| 105 | + - Look for code duplication |
| 106 | + - Suggest code completions when seeing a TODO or FIXME comment |
| 107 | +
|
| 108 | + # TypeScript/JavaScript/React files (Vite Frontend) |
| 109 | + - path: '**/*.{ts,tsx,js,jsx}' |
| 110 | + instructions: | |
| 111 | + TypeScript & React: |
| 112 | + - Avoid 'any', use explicit types. |
| 113 | + - The code adheres to best practices associated with React and Vite. |
| 114 | + - Ensure responsive design principles are followed. |
| 115 | + - Check for proper React hook dependencies and prevent unnecessary re-renders. |
| 116 | +
|
| 117 | + # Rust files (Tauri Backend) |
| 118 | + - path: '**/src-tauri/**/*.rs' |
| 119 | + instructions: | |
| 120 | + Rust (Tauri): |
| 121 | + - Ensure idiomatic Rust code is written. |
| 122 | + - Watch out for unnecessary clone() calls or inefficient memory usage. |
| 123 | + - Ensure errors are handled properly using Result rather than unwrap() or expect(). |
| 124 | + - Ensure Tauri commands are safely exposed to the frontend. |
| 125 | +
|
| 126 | + # Python files (Backend Microservices) |
| 127 | + - path: '**/*.py' |
| 128 | + instructions: | |
| 129 | + Python: |
| 130 | + - Check for PEP 8 violations and Python best practices. |
| 131 | + - Check for performance considerations in asynchronous code. |
| 132 | + - Ensure proper use of type hints. |
| 133 | +
|
| 134 | + # CSS/SCSS files |
| 135 | + - path: '**/*.{css,scss}' |
| 136 | + instructions: | |
| 137 | + CSS & Styling: |
| 138 | + - The code adheres to best practices associated with CSS. |
| 139 | + - Look for responsive design issues. |
| 140 | +
|
| 141 | + # Asset files |
| 142 | + - path: '**/assets/**/*' |
| 143 | + instructions: | |
| 144 | + Assets: |
| 145 | + - Check image optimization and proper formats (WebP, SVG). |
0 commit comments