Skip to content

docs: add PR review guidelines link to README#2281

Merged
manishdait merged 2 commits into
hiero-ledger:mainfrom
De-real-iManuel:docs/add-pr-review-guidelines-link
May 14, 2026
Merged

docs: add PR review guidelines link to README#2281
manishdait merged 2 commits into
hiero-ledger:mainfrom
De-real-iManuel:docs/add-pr-review-guidelines-link

Conversation

@De-real-iManuel

Copy link
Copy Markdown
Contributor

Summary

Adds a new ## Pull Request Reviews section to README.md with a link to the PR review guidelines document, making it easy for community contributors to find the guide.

Changes

  • Added ## Pull Request Reviews section to README.md after ## Contributions
  • Link points to the full GitHub URL of docs/sdk_developers/pr_review_guidelines.md

Fixes #2277

Signed-off-by: Emmanuel Nwajari <De_real_iManuel@hotmail.com>
@De-real-iManuel
De-real-iManuel requested a review from a team as a code owner May 13, 2026 21:40
@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 3c763cc4-2b33-4b54-a399-ed63ce801c66

📥 Commits

Reviewing files that changed from the base of the PR and between 312db19 and da631c7.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The pull request adds a new "Pull Request Reviews" section to README.md that invites community reviews and provides a direct link to PR review guidelines documentation in the docs/sdk_developers directory.

Changes

PR Review Guidelines Documentation

Layer / File(s) Summary
Pull Request Reviews section
README.md
A new README section welcomes community code reviews and links to the PR review guidelines documentation for reviewers.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly describes the main change: adding a PR review guidelines link to the README.
Description check ✅ Passed The description is relevant and provides details about the changes made, including the new section added and the issue being fixed.
Linked Issues check ✅ Passed The PR successfully implements all coding requirements from issue #2277: adds a Pull Request Reviews section to README after Contributions, includes a link to the PR review guidelines document, and references the issue with 'Fixes #2277'.
Out of Scope Changes check ✅ Passed All changes are within scope—only the README.md was modified to add the PR review guidelines link as specified in issue #2277, with no unrelated alterations.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@github-actions github-actions Bot added open to community review PR is open for community review and feedback queue:committers PR awaiting committer technical review labels May 13, 2026

@tech0priyanshu tech0priyanshu 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.

@De-real-iManuel Thanks for Contribution.

@De-real-iManuel

Copy link
Copy Markdown
Contributor Author

Thank you @tech0priyanshu for the assistance.

@github-actions github-actions Bot added the Good First Issue Issues which are ideal for a first time or new project contributor. label May 14, 2026

@aceppaluni aceppaluni 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.

@De-real-iManuel This is looking good and almost ready to merge.

Please update your branch and then well merge, thank you!

@De-real-iManuel

Copy link
Copy Markdown
Contributor Author

I have updated my branch you can merge now. @aceppaluni

@manishdait manishdait added this to the v0.2.7 milestone May 14, 2026
@manishdait
manishdait merged commit 7d3d212 into hiero-ledger:main May 14, 2026
10 checks passed
@github-actions

Copy link
Copy Markdown

👋 Hi @De-real-iManuel! 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

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

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. open to community review PR is open for community review and feedback queue:committers PR awaiting committer technical review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Add PR Review Guidlines Link to Readme

6 participants