docs: add PR review guidelines for community reviewers by sudo-anshul · Pull Request #2271 · hiero-ledger/hiero-sdk-python

sudo-anshul · 2026-05-12T22:25:35Z

Description:

Add PR review guidelines document for community reviewers.

Add docs/sdk_developers/pr_review_guidelines.md covering quality checks, review best practices, and a DO/DON'T checklist
Document commit signing verification (GPG/DCO), issue linkage, and CI workflow checks
Document review best practices (circle of competence, communication style, research process, AI caution)
Add cross-references to existing guides and community help resources

Related issue(s):

Fixes #2228

Notes for reviewer:

Documentation-only change — single new file, no source code or test changes
All 7 relative links and 6 external URLs verified
Follows established doc patterns in docs/sdk_developers/ (H1 title, TOC, numbered H2 sections, DO ✅ / DON'T ❌ format, "Need Help?" footer)

Checklist

Documented (Code comments, README, etc.)
Tested (unit, integration, etc.)

coderabbitai · 2026-05-12T22:27:00Z

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: e240faca-7431-4e9e-99dd-9d2ce90a7bea

📥 Commits

Reviewing files that changed from the base of the PR and between e4866dd and 0e125fd.

📒 Files selected for processing (1)

docs/sdk_developers/pr_review_guidelines.md

Walkthrough

Adds docs/sdk_developers/pr_review_guidelines.md, a new documentation page specifying Hiero Python SDK pull-request review expectations: required quality checks (GPG/DCO signing, issue linkage, CI), reviewer best practices (communication, competence, research, language checks, AI caution), a DO/DON’T checklist, and related resource links.

Changes

PR Review Guidelines Documentation

Layer / File(s)	Summary
PR Review Guidelines Documentation `docs/sdk_developers/pr_review_guidelines.md`	New documentation page outlining community review expectations, required PR quality checks (GPG/DCO signing, issue linkage/resolution, CI workflows), reviewer best practices (circle of competence, communication style, research process, documentation/language checks, AI review caution), a quick-reference DO/DON’T checklist, and links to contribution, testing, signing, linting, conduct, and support resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: add PR review guidelines for community reviewers' clearly and concisely summarizes the main change: adding a new documentation file for PR review guidelines.
Description check	✅ Passed	The description is well-detailed and directly related to the changeset, covering the new documentation file, its content sections, verification of links, adherence to established patterns, and the related issue.
Linked Issues check	✅ Passed	The pull request fully addresses issue `#2228` by delivering a comprehensive PR review guidelines document that covers all required objectives: explicit community review eligibility, quality checks (GPG/DCO signing, issue linkage, CI workflows), review best practices (circle of competence, communication style, code study, language checks, AI caution), DO/DON'T checklist, and cross-references to contributor resources.
Out of Scope Changes check	✅ Passed	All changes are in-scope: the single new documentation file directly fulfills issue `#2228` requirements, with no extraneous modifications to source code, tests, or unrelated documentation.
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: #2228

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8c5927e4-585e-4523-a1f5-6054cdcad600

📥 Commits

Reviewing files that changed from the base of the PR and between 5345fd5 and e4866dd.

📒 Files selected for processing (1)

docs/sdk_developers/pr_review_guidelines.md

Closes hiero-ledger#2228 Create a comprehensive guide at docs/sdk_developers/pr_review_guidelines.md for community members reviewing pull requests labeled 'reviewer: community'. The document covers: - Quality checks (GPG/DCO signing, issue linkage, CI workflow checks) - Review best practices (communication style, research process, AI caution) - DO/DON'T quick reference checklist - Cross-references to related documentation and help resources Signed-off-by: Anshul Kushwaha <137977998+sudo-anshul@users.noreply.github.com>

exploreriii

Great guide! Thank you

manishdait

@sudo-anshul, Please update the branch

AntonioCeppellini

thanks for your contribution @sudo-anshul :D great work!

github-actions · 2026-05-13T14:49:57Z

👋 Hi @sudo-anshul! Great work completing a Good First Issue issue! 🎉

Thanks for your contribution! 🚀

Here are some issues you might want to explore next:

🌟 Stay connected:

Happy coding! 🚀
— Hiero Python SDK Team

sudo-anshul · 2026-05-13T17:17:21Z

thank you all so much for the support and quick reviews!

a huge thanks to @exploreriii for assigning the issue, guiding through the process, and merging the PR.. really appreciated!

thanks to @manishdait for the review and feedback, and @AntonioCappiello for the encouragement... it means a lot!

this was a great first experience contributing to the Hiero Python SDK. looking forward to more!!

…2271) Signed-off-by: Anshul Kushwaha <137977998+sudo-anshul@users.noreply.github.com>

sudo-anshul requested review from a team as code owners May 12, 2026 22:25

sudo-anshul requested review from AntonioCeppellini and nadineloepfe May 12, 2026 22:25

coderabbitai Bot reviewed May 12, 2026

View reviewed changes

Comment thread docs/sdk_developers/pr_review_guidelines.md Outdated

sudo-anshul force-pushed the docs/pr-review-guidelines branch from e4866dd to 93ad03d Compare May 12, 2026 22:29

aceppaluni added step: 1st 1st stage of the review approval process reviewer: junior committer request review from junior committers with triage permissions labels May 12, 2026

github-actions Bot added open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review labels May 12, 2026

exploreriii approved these changes May 13, 2026

View reviewed changes

github-actions Bot added Good First Issue Issues which are ideal for a first time or new project contributor. scope: docs involves documentation labels May 13, 2026

manishdait added this to the v0.2.7 milestone May 13, 2026

manishdait approved these changes May 13, 2026

View reviewed changes

github-actions Bot added status: ready-to-merge PR has 1+ maintainer and 2+ total approvals, ready to merge and removed queue:junior-committer PR awaiting initial quality review labels May 13, 2026

exploreriii removed the reviewer: junior committer request review from junior committers with triage permissions label May 13, 2026

Merge branch 'main' into docs/pr-review-guidelines

0e125fd

AntonioCeppellini approved these changes May 13, 2026

View reviewed changes

exploreriii merged commit b56df16 into hiero-ledger:main May 13, 2026
10 checks passed

NssGourav pushed a commit to NssGourav/hiero-sdk-python that referenced this pull request May 14, 2026

docs: add PR review guidelines for community reviewers (hiero-ledger#…

57954af

…2271) Signed-off-by: Anshul Kushwaha <137977998+sudo-anshul@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add PR review guidelines for community reviewers#2271

docs: add PR review guidelines for community reviewers#2271
exploreriii merged 2 commits into
hiero-ledger:mainfrom
sudo-anshul:docs/pr-review-guidelines

sudo-anshul commented May 12, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 12, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

exploreriii left a comment

Uh oh!

manishdait left a comment

Uh oh!

AntonioCeppellini left a comment

Uh oh!

Uh oh!

github-actions Bot commented May 13, 2026

Uh oh!

sudo-anshul commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

sudo-anshul commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

exploreriii left a comment

Choose a reason for hiding this comment

Uh oh!

manishdait left a comment

Choose a reason for hiding this comment

Uh oh!

AntonioCeppellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented May 13, 2026

Uh oh!

sudo-anshul commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sudo-anshul commented May 12, 2026 •

edited

Loading

coderabbitai Bot commented May 12, 2026 •

edited

Loading