Skip to content

Conversation

@ykmr1224
Copy link
Collaborator

Description

  • Improve CodeRabbit config based on recent PR
  • Removed General review instructions since it was not valid config in coderabbit.yml

Related Issues

n/a

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • New functionality has javadoc added.
  • New functionality has a user manual doc added.
  • New PPL command checklist all confirmed.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff or -s.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tomoyuki Morita <moritato@amazon.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Configuration Updates

    • Added path_filters and drafts flag to control which PRs/files are auto-reviewed and to skip draft PRs
    • New chat.art toggle to disable ASCII art
  • Knowledge Base

    • Enabled web search and localized knowledge scopes with per-project guideline links
  • Documentation

    • Switched docs to Markdown and relaxed language-identifier checks
  • Tests

    • Expanded testing requirements and test-data guidance (NDJSON, integration tests); avoid flagging inline/shared test data
  • Tone

    • Centralized REVIEW_GUIDELINES referenced; added review tone and concise-feedback rules

✏️ Tip: You can customize this high-level summary in your review settings.

Walkthrough

Replaces and centralizes review guidance: updates .coderabbit.yaml to add path_filters and drafts, remove global instructions, reference .rules/REVIEW_GUIDELINES.md for file-type rules, change docs pattern to docs/**/*.md, add chat/art toggle and a knowledge_base configuration, and expands/rewrites REVIEW_GUIDELINES.md.

Changes

Cohort / File(s) Summary
CodeRabbit config
\.coderabbit\.yaml
Adds path_filters under reviews, drafts under auto_review; removes global instructions; switches many per-path blocks to reference centralized guidelines; changes docs path to docs/**/*.md; adds chat.art flag and knowledge_base config (web_search, local scopes, code_guidelines file pattern).
Centralized guidelines
\.rules/REVIEW_GUIDELINES.md
Rewrites and expands general and Java standards, testing requirements, parser/grammar guidance, review tone/focus, and code quality principles; adds explicit test expectations, resource management and maintainability guidance.
Paths & test/data handling
\.coderabbit\.yaml (paths)
Replaces many bespoke file-specific checks with references to REVIEW_GUIDELINES.md; broadens allowed doc/test-data formats (NDJSON, .md docs) and clarifies rules about inline test data and test helpers.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • anirudha
  • LantaoJin
  • penghuo
  • ps48
  • yuancu
  • kavithacm
  • derek-ho
  • joshuali925
  • GumpacG
  • Swiddis
  • forestmvey
  • noCharger
  • YANG-DB
  • mengweieric
  • Yury-Fridlyand
  • MaxKsyunz
  • vamsimanohar
  • acarbonetto
  • seankao-az
  • qianheng-aws
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Improve coderabbit config' accurately describes the main changes in the PR, which primarily involve improvements to the .coderabbit.yaml configuration file.
Description check ✅ Passed The description is related to the changeset, explaining that the PR improves CodeRabbit config and removes invalid configuration. It aligns with the actual changes made to .coderabbit.yaml and .rules/REVIEW_GUIDELINES.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@LantaoJin LantaoJin added the infrastructure Changes to infrastructure, testing, CI/CD, pipelines, etc. label Jan 15, 2026
Copy link
Collaborator

@dai-chen dai-chen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious are these new tenets collected / summarized from somewhere?

Signed-off-by: Tomoyuki Morita <moritato@amazon.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.coderabbit.yaml:
- Around line 161-172: The tone_instructions entry is currently an array and
misplaced; change it to a single top-level string under the key
tone_instructions (not nested under reviews) and condense the content to one
clear sentence <=250 characters; update the existing array value (referenced as
tone_instructions) to a single-line string that summarizes the most important
directives (conciseness, focus on functional issues, avoid repeated suggestions)
so the schema accepts it.

.coderabbit.yaml Outdated
Comment on lines 161 to 172
# Tone instructions to reduce noise
tone_instructions:
- "Be concise and focus on functional issues, not cosmetic ones"
- "Do NOT suggest minor refactorings unless the code is clearly problematic (>100 lines, deeply nested, etc.)"
- "Do NOT flag missing JavaDoc on test methods, test helpers, or private methods"
- "Do NOT suggest loading test data from files if inline data is clearer"
- "Do NOT flag NDJSON format as invalid JSON"
- "Do NOT suggest adding language identifiers to markdown code blocks unless it's a documentation file"
- "Prioritize: correctness > performance > maintainability > style"
- "When suggesting improvements, explain WHY, not just WHAT"
- "Do NOT repeat the same suggestion multiple times in a review"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Fix tone_instructions schema violations (wrong location + type + length).
Schema requires a top‑level string (max 250 chars). The current array under reviews will be ignored or rejected.

✅ Suggested fix (move to top‑level and condense)
 language: "en-US"
 early_access: false
+tone_instructions: "Be concise; focus on functional issues. Avoid minor refactors unless >100 lines or deeply nested. Prioritize correctness>performance>maintainability>style. Avoid duplicate suggestions."
 
 reviews:
   profile: "chill"
@@
-  # Tone instructions to reduce noise
-  tone_instructions:
-    - "Be concise and focus on functional issues, not cosmetic ones"
-    - "Do NOT suggest minor refactorings unless the code is clearly problematic (>100 lines, deeply nested, etc.)"
-    - "Do NOT flag missing JavaDoc on test methods, test helpers, or private methods"
-    - "Do NOT suggest loading test data from files if inline data is clearer"
-    - "Do NOT flag NDJSON format as invalid JSON"
-    - "Do NOT suggest adding language identifiers to markdown code blocks unless it's a documentation file"
-    - "Prioritize: correctness > performance > maintainability > style"
-    - "When suggesting improvements, explain WHY, not just WHAT"
-    - "Do NOT repeat the same suggestion multiple times in a review"
🤖 Prompt for AI Agents
In @.coderabbit.yaml around lines 161 - 172, The tone_instructions entry is
currently an array and misplaced; change it to a single top-level string under
the key tone_instructions (not nested under reviews) and condense the content to
one clear sentence <=250 characters; update the existing array value (referenced
as tone_instructions) to a single-line string that summarizes the most important
directives (conciseness, focus on functional issues, avoid repeated suggestions)
so the schema accepts it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to coderabbit doc, tone_instructions should be a string less than 250 characters under the root level.

AI gave the following recommendations:

  • Move tone_instructions to root level and consolidate into a single string (max 250 chars)

If want to keep it as a list

  • Use path_instructions with a catch-all pattern
  • Put them in your .rules/REVIEW_GUIDELINES.md file

Copy link
Collaborator

@RyanL1997 RyanL1997 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ykmr1224 , thanks for the change.

.coderabbit.yaml Outdated
# Tone instructions to reduce noise
tone_instructions:
- "Be concise and focus on functional issues, not cosmetic ones"
- "Do NOT suggest minor refactorings unless the code is clearly problematic (>100 lines, deeply nested, etc.)"
Copy link
Collaborator

@RyanL1997 RyanL1997 Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

>100 lines

What is this referring to? Like more than 100 lines for a single function or when the diff is more than 100 lines it start considering giving some refactoring suggestions?

dai-chen
dai-chen previously approved these changes Jan 20, 2026
Signed-off-by: Tomoyuki Morita <moritato@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infrastructure Changes to infrastructure, testing, CI/CD, pipelines, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants