Skip to content

chore: add CodeRabbit configuration file#165

Open
Muneerali199 wants to merge 2 commits intoAOSSIE-Org:devfrom
Muneerali199:add-coderabbit-config
Open

chore: add CodeRabbit configuration file#165
Muneerali199 wants to merge 2 commits intoAOSSIE-Org:devfrom
Muneerali199:add-coderabbit-config

Conversation

@Muneerali199
Copy link

Adds the standardized CodeRabbit configuration file (.coderabbit.yaml)
as discussed here :https://discord.com/channels/1022871757289422898/1235508903450775622/1474646668183081010

@Muneerali199 Muneerali199 requested a review from M4dhav as a code owner February 22, 2026 08:38
@coderabbitai
Copy link

coderabbitai bot commented Feb 22, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@Muneerali199
Copy link
Author

please sir @M4dhav review it when you are free and let me know if further changes require

Comment on lines +24 to +31
planning:
enabled: true
auto_planning:
enabled: true
labels:
- "plan-me" # Auto-plan issues with this label
- "feature" # Also auto-plan these
- "!no-plan" # Never auto-plan issues with this label
Copy link
Contributor

Choose a reason for hiding this comment

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

Turn off Planning. AI should not be used for Architecture and Feature Planning in it's entirety.

.coderabbit.yaml Outdated
# Only auto-review PRs targeting these branches
base_branches:
- main
- develop
Copy link
Contributor

Choose a reason for hiding this comment

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

We use the dev branch, not develop

.coderabbit.yaml Outdated
sequence_diagrams: true

# Include poems in reviews
poem: true
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't need poems, can set this to false.

.coderabbit.yaml Outdated
review_status: true

# Keep the walkthrough section expanded by default
collapse_walkthrough: false
Copy link
Contributor

Choose a reason for hiding this comment

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

Change to true

.coderabbit.yaml Outdated
pre_merge_checks:
description:
# Validate that PR has a proper description
mode: warning # Options: off, warning, error
Copy link
Contributor

Choose a reason for hiding this comment

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

Change to error

.coderabbit.yaml Outdated
Comment on lines +202 to +214
# HTML files
- path: "**/*.html"
instructions: |
Review the HTML code against the google html style guide and point out any mismatches. Ensure that:
- The code adheres to best practices recommended by lighthouse or similar tools for performance

# CSS files
- path: "**/*.css"
instructions: |
Review the CSS code against the google css style guide and point out any mismatches. Ensure that:
- The code adheres to best practices associated with CSS.
- The code adheres to best practices recommended by lighthouse or similar tools for performance.
- The code adheres to similar naming conventions for classes, ids.
Copy link
Contributor

Choose a reason for hiding this comment

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

Irrelevant here

.coderabbit.yaml Outdated
Comment on lines +222 to +245
# Solidity Smart Contract files
- path: "**/*.sol"
instructions: |
Solidity:
- Review the Solidity contracts for security vulnerabilities and adherence to best practices.
- Ensure immutability is used appropriately (e.g., `immutable` and `constant` where applicable).
- Ensure there are no unbounded loops that could lead to gas exhaustion.
- Verify correct and explicit visibility modifiers for all state variables and functions.
- Flag variables that are declared but used only once or are unnecessary.
- Identify potential gas optimization opportunities without compromising readability or security.
- Verify that any modification to contract logic includes corresponding updates to automated tests.
- Ensure failure paths and revert scenarios are explicitly handled and validated.
- Validate proper access control enforcement (e.g., Ownable, RBAC, role checks).
- Ensure consistent and correct event emission for all state-changing operations.
- Confirm architectural consistency with existing contracts (no unintended storage layout changes unless clearly documented).
- Flag major feature additions or architectural changes that were implemented without prior design discussion (if applicable).
- Flag pull requests that mix unrelated changes or multiple concerns in a single submission.
- Ensure security-sensitive logic changes are not introduced without adequate test coverage.
- Review for common smart contract vulnerabilities, including but not limited to:
- Reentrancy
- Improper input validation
- Access control bypass
- Integer overflows/underflows (if using unchecked blocks)
- Front-running risks where applicable
Copy link
Contributor

Choose a reason for hiding this comment

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

Irrelevant here

.coderabbit.yaml Outdated
instructions: |
Review test files for:
- Comprehensive coverage of component behavior
- Proper use of @testing-library/react-native
Copy link
Contributor

Choose a reason for hiding this comment

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

Irrelevant here

.coderabbit.yaml Outdated
Comment on lines +259 to +270
# Solidity test files
- path: "**/*.test.{sol}"
instructions: |
Review test files for:
- Comprehensive coverage of contract behavior.
- Coverage of success paths, edge cases, and failure/revert scenarios.
- Proper validation of access control restrictions.
- Verification of event emissions where applicable.
- Explicit validation of state changes after each relevant function call.
- Adequate test updates whenever contract logic is modified.
- Deterministic behavior (tests should not rely on implicit execution order or shared mutable state).
- Clear and descriptive test names that reflect the intended behavior being validated.
Copy link
Contributor

Choose a reason for hiding this comment

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

Irrelevant here

.coderabbit.yaml Outdated


# Asset files (images, fonts, etc.)
- path: "assets/**/*"
Copy link
Contributor

Choose a reason for hiding this comment

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

Our assets aren't inside a subfolder

@Muneerali199
Copy link
Author

sir @M4dhav , I Applied all requested changes to .coderabbit.yaml and cleaned up irrelevant configurations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants