Skip to content

Commit b02f3ee

Browse files
committed
chore: add real-world coderabbit config examples for python, rust, unity and docs
1 parent 41b4dcc commit b02f3ee

File tree

3 files changed

+104
-0
lines changed

3 files changed

+104
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
language: 'en-US'
3+
early_access: true
4+
tone_instructions: "Provide clear, objective, and detailed feedback with a professional and constructive tone, focusing on actionable suggestions for improvement."
5+
reviews:
6+
request_changes_workflow: true
7+
high_level_summary: true
8+
poem: false
9+
review_status: true
10+
collapse_walkthrough: false
11+
profile: assertive
12+
tools:
13+
markdownlint:
14+
enabled: true
15+
ast-grep:
16+
essential_rules: true
17+
github-checks:
18+
enabled: true
19+
timeout_ms: 90000
20+
ruff:
21+
enabled: false
22+
shellcheck:
23+
enabled: true
24+
auto_review:
25+
enabled: true
26+
ignore_title_keywords:
27+
- '[skip review]'
28+
- 'Automatic PR'
29+
drafts: false
30+
base_branches:
31+
- 'main'
32+
path_instructions:
33+
- path: '**/*.ts'
34+
instructions: 'Review the TypeScript code of the NPM package to ensure it adheres to the principles of awesome and clean code. This includes proper use of functions, classes, modules. Also, ensure the code follows best practices for package development, such as clear and concise documentation, proper error handling, and efficient data structures and algorithms. The code should also conform to the ESLint rules configured in the codebase. Highlight any deviations and suggest appropriate corrections. Using design patterns that promote code reusability and readability is encouraged.'
35+
- path: '**/*.md'
36+
instructions: "Review the Markdown files to ensure they are well-structured follow Docusaurus's best practices, easy to read, and contain accurate and up-to-date information. Check for proper formatting, grammar, and spelling. Ensure that the content is relevant and engaging for the target audience. Highlight any inconsistencies or errors and suggest improvements to enhance the overall quality of the documentation."
37+
- path: 'test/**/*'
38+
instructions: 'Review the test files to ensure they cover all the relevant use cases and edge cases of the codebase. Check for proper test coverage, assertions, and error handling. Ensure that the tests are well-organized, easy to read, and provide meaningful feedback. Highlight any missing or redundant tests and suggest improvements to enhance the overall quality of the test suite.'
39+
chat:
40+
auto_reply: true
41+
knowledge_base:
42+
learnings:
43+
scope: auto
44+
issues:
45+
scope: auto
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
language: "ja"
2+
early_access: false
3+
reviews:
4+
request_changes_workflow: false
5+
high_level_summary: true
6+
poem: true
7+
review_status: true
8+
collapse_walkthrough: false
9+
path_filters:
10+
- "!**/.toml"
11+
- "!**/.c"
12+
- "!**/CMakeLists.txt"
13+
path_instructions:
14+
- path: "**/*.rs"
15+
instructions: |
16+
あなたは @coderabbitai(別名 github-actions[bot])で、OpenAIによって訓練された言語モデルです。
17+
あなたの目的は、非常に経験豊富なソフトウェアエンジニアとして機能し、コードの一部を徹底的にレビューし、
18+
以下のようなキーエリアを改善するためのコードスニペットを提案することです:
19+
- ロジック
20+
- セキュリティ
21+
- パフォーマンス
22+
- データ競合
23+
- 一貫性
24+
- エラー処理
25+
- 保守性
26+
- モジュール性
27+
- 複雑性
28+
- 最適化
29+
- ベストプラクティス: DRY, SOLID, KISS
30+
31+
些細なコードスタイルの問題や、コメント・ドキュメントの欠落についてはコメントしないでください。
32+
重要な問題を特定し、解決して全体的なコード品質を向上させることを目指してくださいが、細かい問題は意図的に無視してください。
33+
auto_review:
34+
enabled: true
35+
ignore_title_keywords:
36+
- "WIP"
37+
- "DO NOT MERGE"
38+
drafts: false
39+
base_branches:
40+
- "develop"
41+
- "feature/*"
42+
chat:
43+
auto_reply: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
chat:
2+
auto_reply: true
3+
early_access: true
4+
language: en
5+
reviews:
6+
auto_review:
7+
enabled: true
8+
path_filters:
9+
- '!Assets'
10+
- '!Packages/com.vrchat.core.*/**/*'
11+
- '!ProjectSettings'
12+
path_instructions:
13+
- instructions: This folder contains C# files, but these are UdonSharp and have different restrictions than standard C#. Please review with this in mind.
14+
path: Assets/black.kit.*/Runtime/**/*
15+
- instructions: Some files look broken, but they contain templates from Scriban. Please review with this in mind.
16+
path: Website/**/*

0 commit comments

Comments
 (0)