Skip to content

Conversation

@exploreriii
Copy link
Contributor

Description:
Adds detail and fixes syntax error in beginner template

Related issue(s):

Fixes #1344
Fixes #1345

@exploreriii exploreriii marked this pull request as ready for review January 4, 2026 13:05
@codecov
Copy link

codecov bot commented Jan 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1349   +/-   ##
=======================================
  Coverage   92.29%   92.29%           
=======================================
  Files         139      139           
  Lines        8515     8515           
=======================================
  Hits         7859     7859           
  Misses        656      656           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai
Copy link

coderabbitai bot commented Jan 4, 2026

📝 Walkthrough

Walkthrough

The beginner issue template is updated with more inclusive language, improved structure, and task-focused guidance emphasizing AccountId.repr() implementation and debugging context. A corresponding changelog entry is added.

Changes

Cohort / File(s) Summary
Issue Template Updates
.github/ISSUE_TEMPLATE/05_beginner_issue.yml
Language refined for inclusivity ("fairly new contributors"); indentation corrected in YAML validation blocks; solution and implementation sections refocused on AccountId.repr() task; step-by-step guidance revised to emphasize actionable checklist items; debugging context and example output clarified.
Changelog Documentation
CHANGELOG.md
Added bullet point under "Unreleased > Added" section noting the addition of relevant examples to the beginner issue template.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding detail to the beginner template and fixing a syntax error.
Description check ✅ Passed The description is directly related to the changeset, mentioning the addition of detail and syntax error fixes in the beginner template, and references the linked issues.
Linked Issues check ✅ Passed The PR successfully addresses both linked issues: fixes the YAML indentation syntax error in the beginner template [#1344] and adds detailed, relevant examples to improve the template content [#1345].
Out of Scope Changes check ✅ Passed All changes are scoped to the beginner template and changelog, directly addressing the objectives in issues #1344 and #1345 with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ca07c6 and 4722b37.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/05_beginner_issue.yml
  • CHANGELOG.md
⏰ 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). (7)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: build-and-test (3.11)
  • GitHub Check: build-and-test (3.10)
  • GitHub Check: build-and-test (3.13)
  • GitHub Check: build-and-test (3.12)
  • GitHub Check: run-examples
  • GitHub Check: StepSecurity Harden-Runner
🔇 Additional comments (5)
CHANGELOG.md (1)

37-37: LGTM!

The changelog entry accurately reflects the template improvements made in this PR.

.github/ISSUE_TEMPLATE/05_beginner_issue.yml (4)

25-26: LGTM! Indentation fix resolves the YAML syntax error.

The validations block is now correctly aligned with the attributes key, fixing the rendering bug reported in issue #1344.


63-67: Excellent improvement to issue creation guidance.

The updated description now provides clear guidance for maintainers to create approachable yet educational beginner issues, striking a good balance between support and challenge.


139-150: Well-structured implementation guidance.

The checklist provides clear, actionable steps that encourage contributors to learn from existing patterns in the codebase before implementing their solution. The progression from reviewing existing code to implementing and testing is pedagogically sound for beginner contributors.


110-118: Field names in the proposed example are correct. The AccountId class has shard, realm, and num fields as shown. The proposed __repr__() format accurately matches the class structure.

@exploreriii exploreriii requested a review from manishdait January 4, 2026 13:12
@exploreriii exploreriii merged commit 7f35aef into hiero-ledger:main Jan 4, 2026
23 checks passed
cxhello pushed a commit to cxhello/hiero-sdk-python that referenced this pull request Jan 5, 2026
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.

[Intermediate]: Update beginner issue templates with relevant examples [Good First Issue]: Correct beginner issue template syntax

2 participants