Skip to content

Commit 1ee27a0

Browse files
committed
chore: add real-world coderabbit config examples for python, typescript, javascript and golang
1 parent c827774 commit 1ee27a0

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
language: "en-US"
3+
early_access: true
4+
reviews:
5+
path_filters:
6+
- "!**/*.xml"
7+
- "!**/*.yaml"
8+
- "!components/Ui/**"
9+
path_instructions:
10+
- path: "**/*.vue"
11+
instructions: |
12+
Review Vue files for a Nuxt3 project. Ensure that:
13+
- The `<script>` section adheres to TypeScript guidelines and best practices, including:
14+
- Proper type annotations and usage.
15+
- Usage of modern TypeScript features.
16+
- Avoidance of any type-related issues or anti-patterns.
17+
- The `<template>` section uses proper HTML and follows TailwindCSS guidelines, including:
18+
- Correct usage of TailwindCSS utility classes for styling.
19+
- Semantic HTML structure and accessibility considerations.
20+
- The overall file adheres to Nuxt3 conventions and best practices, such as:
21+
- Correct usage of Nuxt3-specific features like composables, plugins, and auto-imported components.
22+
- Efficient use of the Composition API and reactive data handling.
23+
- path: "**/*.ts"
24+
instructions: |
25+
Review the TypeScript code files for the project. Ensure that:
26+
- The code adheres to TypeScript best practices and guidelines, including:
27+
- Proper type annotations and usage.
28+
- Utilization of modern TypeScript features (e.g., optional chaining, nullish coalescing).
29+
- Avoidance of any type-related issues or anti-patterns.
30+
- The code follows general software engineering best practices, such as:
31+
- Modular and maintainable code structure.
32+
- Clear and concise documentation and comments where necessary.
33+
- Efficient and readable code with a focus on performance and security.
34+
profile: "assertive"
35+
request_changes_workflow: true

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy