docs: Add comprehensive Good First Issue guidelines #1069
Conversation
There was a problem hiding this comment.
Pull request overview
This PR creates comprehensive documentation for Good First Issue (GFI) guidelines in the Hiero Python SDK, addressing issue #1065. The documentation provides clear criteria for maintainers to identify appropriate issues for new contributors.
Key Changes
- Renamed and significantly expanded
good_first_issues.mdtogood_first_issues_guidelines.mdwith detailed categorization - Defined 7 allowed GFI categories (typing improvements, documentation, small refactors, etc.) and 4 explicitly excluded categories (new tests, core protocol logic, architectural changes, etc.)
- Added maintainer guidance with clear decision criteria and reminders about GFI visibility
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/maintainers/good_first_issues_guidelines.md | New comprehensive 249-line guideline document defining allowed and disallowed GFI categories with examples and maintainer decision criteria |
| CHANGELOG.md | Added entry documenting the new guidelines file in the "Added" section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
exploreriii
left a comment
exploreriii
left a comment
There was a problem hiding this comment.
I appreciate your excitement but you need to test your file before asking for a review
note these don't wrok
[Print and Output Clarity]
[Functional Improvements to Examples]
I am bug fixing right now and getting pulled away constantly for sub-par PRs is not right
|
Hi @adityashirsatrao007 sorry I was not very clear or helpful in the previous message Please click all your table of contents, because some of the sections are not jumping to anything |
|
Yes I'll work on it |
|
Hello, this is the Office Hour Bot. This is a reminder that the Hiero Python SDK Office Hours are scheduled in approximately 4 hours (14:00 UTC). This session provides an opportunity to ask questions regarding this Pull Request or receive assistance from a maintainer. Details:
Disclaimer: This is an automated reminder. Please verify the schedule here to be notified of any changes. |
adityashirsatrao007
force-pushed
the
docs/good-first-issue-guidelines
branch
from
d84f782 to
9784451
Compare
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThis PR adds comprehensive Good First Issue (GFI) guidelines to the Hiero Python SDK documentation and updates the CHANGELOG.md to reflect this addition. The new guidelines document defines allowed and disallowed GFI categories, provides maintainer labeling guidance, and links to relevant contributor resources. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
- Renamed good_first_issues.md to good_first_issues_guidelines.md - Added detailed categories of allowed GFI work: - Small, focused source changes - Typing improvements - Refactors of existing examples - Documentation improvements - Print/output clarity in examples - Functional improvements to examples - Test improvements (additive only) - Added explicit list of what is NOT considered a GFI - Added maintainer guidance for labeling decisions - Linked to relevant documentation resources Closes hiero-ledger#1065 Signed-off-by: Aditya Shirsatrao <[email protected]> Signed-off-by: adityashirsatrao007 <[email protected]> Signed-off-by: Aditya <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Aditya <[email protected]>
- Fixed ToC anchor links for Print/Output Clarity and Functional Improvements (removed invisible Unicode variation selectors from emoji anchors) - Fixed Contributing Guide link path from ../CONTRIBUTING.md to ../../CONTRIBUTING.md Signed-off-by: Aditya Shirsatrao <[email protected]> Signed-off-by: adityashirsatrao007 <[email protected]> Signed-off-by: Aditya <[email protected]>
…te_guidelines Signed-off-by: Aditya <[email protected]>
Signed-off-by: Aditya <[email protected]>
adityashirsatrao007
force-pushed
the
docs/good-first-issue-guidelines
branch
from
2ee1f38 to
d4d15f8
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.md(3 hunks)docs/maintainers/good_first_issue_candidate_guidelines.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/maintainers/good_first_issue_candidate_guidelines.md
[style] ~181-~181: Consider a different adjective to strengthen your wording.
Context: ...ample files or workflows These require deeper understanding of intended usage pattern...
(DEEP_PROFOUND)
CHANGELOG.md
[uncategorized] ~20-~20: The official name of this software platform is spelled with a capital “H”.
Context: ...print_account_summary()(#1016) - Added.github/workflows/bot-pr-auto-draft-on-changes....
(GITHUB)
[uncategorized] ~42-~42: The official name of this software platform is spelled with a capital “H”.
Context: ...rst Issue guidelines (#1034) - Added new `.github/ISSUE_TEMPLATE/04_good_first_issue_cand...
(GITHUB)
[uncategorized] ~43-~43: The official name of this software platform is spelled with a capital “H”.
Context: ...hiero-sdk-python/issues/1068) - Enhanced .github/ISSUE_TEMPLATE/01_good_first_issue.yml...
(GITHUB)
[uncategorized] ~45-~45: The official name of this software platform is spelled with a capital “H”.
Context: ...l` - Added Issue Reminder (no-PR) bot, .github/scripts/issue_reminder_no_pr.sh and .gi...
(GITHUB)
[uncategorized] ~45-~45: The official name of this software platform is spelled with a capital “H”.
Context: ...ub/scripts/issue_reminder_no_pr.sh and .github/workflows/bot-issue-reminder-no-pr.yml ...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
docs/maintainers/good_first_issue_candidate_guidelines.md
13-13: Link fragments should be valid
(MD051, link-fragments)
14-14: Link fragments should be valid
(MD051, link-fragments)
CHANGELOG.md
42-42: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
docs/maintainers/good_first_issue_candidate_guidelines.md (1)
1-250: Approve comprehensive GFI guidelines document — well-structured and clear.The document is well-organized, provides concrete examples for each allowed category, and clearly delineates what is out of scope. Once the table of contents links are fixed (see above), this will serve as excellent contributor onboarding material.
|
|
||
|
|
||
| ### Added | ||
|
|
There was a problem hiding this comment.
Remove empty entry marker on line 10.
This line appears to be an empty placeholder entry and should be removed.
### Added
~
- Added SDK-level Good First Issue (GFI) guidelines for maintainers to clarify what qualifies as a good first issue.Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In CHANGELOG.md around line 10 there is an empty placeholder entry; remove that
blank or placeholder line so the changelog has no empty bullet/entry at line 10
and adjust surrounding spacing if necessary to keep formatting consistent.
| - Refactored `account_create_transaction_create_with_alias.py` example by splitting monolithic function into modular functions: `generate_main_and_alias_keys()`, `create_account_with_ecdsa_alias()`, `fetch_account_info()`, `print_account_summary()` (#1016) | ||
| - Added `.github/workflows/bot-pr-auto-draft-on-changes.yml` to automatically convert PRs to draft and notify authors when reviewers request changes. | ||
| - | ||
| - |
There was a problem hiding this comment.
Remove stray placeholder line.
Line 21 contains only a dash and appears to be a leftover placeholder that should be deleted.
- Added comprehensive Good First Issue guidelines documentation (`docs/maintainers/good_first_issue_candidate_guidelines.md`) (#1070)
- Added documentation: "Testing GitHub Actions using Forks" (`docs/sdk_developers/training/testing_forks.md`).
-
- Modularized `transfer_transaction_fungible` example by introducing `account_balance_query()` & `transfer_transaction()`.Renamed `transfer_tokens()` → `main()`Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In CHANGELOG.md around line 21, remove the stray placeholder line that contains
only a single dash; delete that line so the changelog has no empty placeholder
entries and the file content flows correctly.
| - [Print and Output Clarity](#-print-and-output-clarity-examples-only) | ||
| - [Functional Improvements to Examples](#-functional-improvements-to-examples) |
There was a problem hiding this comment.
Fix table of contents anchor links — they do not resolve to their sections.
The TOC links include a leading dash or emoji prefix that doesn't match the auto-generated anchor IDs. Markdown strips emoji and converts headers to lowercase with spaces as hyphens. Remove the leading dash from the fragments to align with actual generated anchors.
This resolves the issue flagged in PR comments.
- [Allowed Categories](#allowed-categories)
- - [Small, Focused Source Changes](#-small-focused-source-changes)
- - [Typing Improvements](#-typing-improvements)
- - [Refactors of Existing Examples](#-refactors-of-existing-examples)
- - [Documentation Improvements](#-documentation-improvements)
- - [Print and Output Clarity](#-print-and-output-clarity-examples-only)
- - [Functional Improvements to Examples](#-functional-improvements-to-examples)
- - [Test Improvements](#-test-improvements-additive-only)
- - [What We Do NOT Consider Good First Issues](#-what-we-do-not-consider-good-first-issues)
+ - [Small, Focused Source Changes](#small-focused-source-changes)
+ - [Typing Improvements](#typing-improvements)
+ - [Refactors of Existing Examples](#refactors-of-existing-examples)
+ - [Documentation Improvements](#documentation-improvements)
+ - [Print and Output Clarity](#print-and-output-clarity-examples-only)
+ - [Functional Improvements to Examples](#functional-improvements-to-examples)
+ - [Test Improvements](#test-improvements-additive-only)
+ - [What We Do NOT Consider Good First Issues](#what-we-do-not-consider-good-first-issues)
- [Maintainer Guidance](#-maintainer-guidance)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
13-13: Link fragments should be valid
(MD051, link-fragments)
14-14: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/maintainers/good_first_issue_candidate_guidelines.md around lines 13-14,
the table-of-contents anchor links include a leading dash/emoji prefix that
doesn't match the generated Markdown anchors; remove the leading dash/emoji from
those fragment links so they match the auto-generated anchors (convert header
text to lowercase with spaces as hyphens if needed) so the TOC links resolve to
their sections.
|
Closing as is duplicated in your other PR |
2 participants
Description
This PR creates comprehensive documentation for what constitutes a Good First Issue in the Hiero Python SDK, as requested in #1065.
Changes Made
Renamed \docs/maintainers/good_first_issues.md\ → \docs/maintainers/good_first_issues_guidelines.md\
Added comprehensive content including:
Allowed GFI Categories:
What is NOT a GFI:
Maintainer Guidance:
Closes
Closes #1065
Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.