Skip to content

feat: add CodeRabbit review instructions for account module - #1883

Merged
exploreriii merged 3 commits into
hiero-ledger:mainfrom
MonaaEid:feat/1701-account-review-prompt
Mar 7, 2026
Merged

feat: add CodeRabbit review instructions for account module#1883
exploreriii merged 3 commits into
hiero-ledger:mainfrom
MonaaEid:feat/1701-account-review-prompt

Conversation

@MonaaEid

Copy link
Copy Markdown
Contributor

Description:

This pull request updates .coderabbit.yaml to add comprehensive CodeRabbit review instructions for the account module in src/hiero_sdk_python/account/. These new instructions provide detailed guidance for reviewers on correctness, serialization, edge cases, and test coverage specific to account-related transactions and data types. Additionally, a minor revision was made to an existing review instruction for consistency in flagging deviations.

Related issue(s):

Fixes #1701

Checklist

  • Updated .coderabbit.yaml
  • Documented

Copilot AI review requested due to automatic review settings February 28, 2026 02:02
@MonaaEid
MonaaEid requested a review from a team as a code owner February 28, 2026 02:02
@MonaaEid
MonaaEid requested a review from exploreriii February 28, 2026 02:02
@codecov

codecov Bot commented Feb 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1883   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files         141      141           
  Lines        9146     9146           
=======================================
  Hits         8555     8555           
  Misses        591      591           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai

coderabbitai Bot commented Feb 28, 2026

Copy link
Copy Markdown
Contributor

Warning

Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9443d630-d516-47cb-b36c-539745024fe6

📥 Commits

Reviewing files that changed from the base of the PR and between fa713a8 and 15be29d.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • CHANGELOG.md

Walkthrough

Adds extensive CodeRabbit AI review instructions for the account domain in .coderabbit.yaml (targets src/hiero_sdk_python/account/**/*.py), updates MAJOR-flag wording, and duplicates the same account review block twice. Also adds a changelog entry documenting the new instructions.

Changes

Cohort / File(s) Summary
CodeRabbit configuration
.coderabbit.yaml
Inserted detailed account-domain review guidance targeting src/hiero_sdk_python/account/**/*.py, covering protobuf alignment, AccountId alias/EVM handling, mutation paths, error ergonomics, invariants, transient instances, test expectations, and severity labels. Modified MAJOR flag wording from “deviates from the table above without a comment” to “deviates from sibling-class defaults”. The account review block was duplicated (identical content present twice).
Changelog
CHANGELOG.md
Added an Unreleased entry noting the addition of CodeRabbit review instructions for the src/hiero_sdk_python/account/ module.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: adding CodeRabbit review instructions for the account module.
Description check ✅ Passed The description is directly related to the changeset, explaining the updates to .coderabbit.yaml and referencing the relevant issue.
Linked Issues check ✅ Passed The PR addresses the core requirement from issue #1701 by adding comprehensive CodeRabbit review instructions for the account module in .coderabbit.yaml.
Out of Scope Changes check ✅ Passed Changes are limited to .coderabbit.yaml and CHANGELOG.md, both of which are directly related to adding account module review instructions.
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.

📋 Issue Planner

Built with CodeRabbit's Coding Plans for faster development and fewer bugs.

View plan used: #1701

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

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3


ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between adb9725 and fa713a8.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • CHANGELOG.md

Comment thread .coderabbit.yaml
Comment thread CHANGELOG.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds CodeRabbit review instructions for the src/hiero_sdk_python/account/ directory in .coderabbit.yaml, providing detailed guidance for AI-assisted code review of account-related transactions, queries, and data types. It also includes a minor wording improvement to an existing line in the consensus module instructions.

Changes:

  • Adds new path_instructions block for src/hiero_sdk_python/account/**/*.py with eight review-priority sections covering protobuf correctness, serialization/wire-format integrity, AccountId alias handling, AccountInfo asymmetries, allowance transaction correctness, error handling, API ergonomics, and test coverage.
  • Updates the consensus module instruction at line 1650 to replace the stale reference to "the table above" (no table exists in that section) with the clearer "sibling-class defaults."
  • Adds a CHANGELOG entry documenting the new account-module CodeRabbit instructions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
.coderabbit.yaml Adds account-module path instructions (8 review-priority sections with severity labels) and fixes a minor wording issue in the consensus section
CHANGELOG.md Adds a changelog entry for the new CodeRabbit account module instructions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml Outdated
@github-actions

github-actions Bot commented Mar 1, 2026

Copy link
Copy Markdown

Hi, this is MergeConflictBot.
Your pull request cannot be merged because it contains merge conflicts.

Please resolve these conflicts locally and push the changes.

Quick Fix for CHANGELOG.md Conflicts

If your conflict is only in CHANGELOG.md, you can resolve it easily using the GitHub web editor:

  1. Click on the "Resolve conflicts" button in the PR
  2. Accept both changes (keep both changelog entries)
  3. Click "Mark as resolved"
  4. Commit the merge

For all other merge conflicts, please read:

Thank you for contributing!

@mizoz

mizoz commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

Thanks for setting up these comprehensive CodeRabbit review instructions for the account module, @MonaaEid! This kind of documentation makes AI-assisted reviews much more effective and consistent.

A couple of suggestions:

On the .coderabbit.yaml structure:

  • The protobuf alignment guidance is spot-on. Consider adding a note about version compatibility checks when protobuf definitions change
  • The serialization section could benefit from a quick reference to the canonical serialization test pattern used elsewhere in the SDK

On the merge conflicts:
I see there are merge conflicts in the CHANGELOG.md. The quick fix is to:

  1. Click "Resolve conflicts" in the GitHub web editor
  2. Keep both changelog entries (yours and the conflicting one)
  3. Mark as resolved and commit

This is a great addition to the SDK's review workflow. Well done! 👍

@MonaaEid MonaaEid closed this Mar 7, 2026
@MonaaEid
MonaaEid force-pushed the feat/1701-account-review-prompt branch from cbb42f1 to 3cdc8a5 Compare March 7, 2026 21:15
@MonaaEid MonaaEid reopened this Mar 7, 2026
@MonaaEid MonaaEid closed this Mar 7, 2026
@MonaaEid
MonaaEid force-pushed the feat/1701-account-review-prompt branch from 972b8d5 to 3cdc8a5 Compare March 7, 2026 21:17
@MonaaEid MonaaEid reopened this Mar 7, 2026
Signed-off-by: MonaaEid <monaa_eid@hotmail.com>
@MonaaEid MonaaEid closed this Mar 7, 2026
@MonaaEid
MonaaEid force-pushed the feat/1701-account-review-prompt branch from 77c9291 to e74a5dd Compare March 7, 2026 21:34
MonaaEid added 2 commits March 7, 2026 23:36
Signed-off-by: MonaaEid <monaa_eid@hotmail.com>
Signed-off-by: MonaaEid <monaa_eid@hotmail.com>
@MonaaEid MonaaEid reopened this Mar 7, 2026
@MonaaEid MonaaEid added reviewer: maintainer PR needs a review from the maintainer team and removed status: in initial development labels Mar 7, 2026
@MonaaEid
MonaaEid marked this pull request as ready for review March 7, 2026 21:39

@exploreriii exploreriii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i think th

@exploreriii
exploreriii merged commit 90f1673 into hiero-ledger:main Mar 7, 2026
24 checks passed
@MonaaEid
MonaaEid deleted the feat/1701-account-review-prompt branch March 8, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

reviewer: maintainer PR needs a review from the maintainer team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Advanced]: Prompt code rabbit on how to review src/hiero_sdk_python/account

6 participants