Skip to content

Conversation

@exploreriii
Copy link
Contributor

Description:
This adds a template for beginner issues

Related issue(s):

Fixes #1329

Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Jan 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1330   +/-   ##
=======================================
  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.

@exploreriii exploreriii marked this pull request as ready for review January 4, 2026 10:24
@coderabbitai
Copy link

coderabbitai bot commented Jan 4, 2026

Warning

Rate limit exceeded

@exploreriii has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6caf6ad and 041282e.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/05_beginner_issue.yml
📝 Walkthrough

Walkthrough

Adds a new beginner GitHub issue template at .github/ISSUE_TEMPLATE/05_beginner_issue.yml, applies minor wording/formatting updates to the intermediate issue template, and records the addition in CHANGELOG.md under Unreleased > Added.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
​.github/ISSUE_TEMPLATE/05_beginner_issue.yml, ​.github/ISSUE_TEMPLATE/06_intermediate_issue.yml
Added a comprehensive beginner issue template with guided, validated sections (intro, guidelines, issue, solution, implementation, acceptance criteria, contribution steps, additional info). Updated intermediate template: intro emoji changed (🧩 → 🛠️), problem-example header emoji renamed (🐞 → 📌), eligibility wording adjusted, added warning block, formatting tweaks, and acceptance criteria extended to require unit and integration testing.
Changelog
CHANGELOG.md
Added Unreleased > Added entry noting the new beginner issue template.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a beginner issue template.
Description check ✅ Passed The description is directly related to the changeset, stating the addition of a beginner issue template and referencing the linked issue.
Linked Issues check ✅ Passed The PR successfully implements the beginner issue template at the specified path, includes a changelog entry, and meets all primary coding requirements from issue #1329.
Out of Scope Changes check ✅ Passed Changes to the intermediate issue template are scope-related improvements that enhance the beginner template context. All modifications align with the broader objective of improving issue templates.
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: 4

📜 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 ec903c7 and ab5df5e.

📒 Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/05_beginner_issue.yml
  • .github/ISSUE_TEMPLATE/06_intermediate_issue.yml
  • .github/ISSUE_TEMPLATE/07_advanced_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). (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (4)
CHANGELOG.md (1)

37-37: LGTM!

The changelog entry is clear, concise, and consistent with the existing format.

.github/ISSUE_TEMPLATE/06_intermediate_issue.yml (2)

17-21: Good addition of warning guidance.

The warning block appropriately sets expectations for intermediate contributors and helps maintainers frame issues correctly.


23-23: LGTM! Refinements improve clarity.

The wording adjustments, emoji updates, and additional acceptance criterion align well with the introduction of the beginner template and improve template consistency.

Also applies to: 31-31, 61-61, 94-94

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

1-272: Excellent comprehensive template for beginner contributors.

This beginner issue template is well-designed with:

  • Clear and welcoming introduction
  • Comprehensive guidelines and expectations
  • Detailed examples for each section
  • Step-by-step contribution guide
  • Appropriate validation requirements

The template will provide valuable structure for creating beginner-friendly issues and help new contributors understand expectations and workflow.

Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
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: 2

♻️ Duplicate comments (1)
.github/ISSUE_TEMPLATE/05_beginner_issue.yml (1)

25-26: Fix YAML indentation error (still present).

The validations: block is incorrectly indented. It should be at the same level as id: and attributes: (4 spaces), not nested under attributes: (6 spaces). This YAML syntax error will prevent the template from working correctly.

🔎 Proposed fix
         The purpose of this issue—and others listed under [**Find a beginner issue**](https://github.com/hiero-ledger/hiero-sdk-python/issues?q=is%3Aissue%20state%3Aopen%20label%3Abeginner%20no%3Aassignee)—is to provide a supportive, low-pressure environment where you can learn, practice, and grow your contribution skills with confidence.
-      validations:
-        required: false
+    validations:
+      required: false
📜 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 ab5df5e and 6caf6ad.

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

79-79: No changes needed — example file is already well-modularized.

The example at examples/tokens/token_associate_transaction.py is already structured with multiple helper functions (setup_client(), create_test_account(), create_fungible_token(), associate_token_with_account(), verify_token_association(), etc.), each with a single responsibility. The main() function appropriately orchestrates these steps rather than containing monolithic logic.

Likely an incorrect or invalid review comment.

Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
@exploreriii exploreriii requested a review from manishdait January 4, 2026 12:17
Copy link
Contributor

@manishdait manishdait left a comment

Choose a reason for hiding this comment

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

LGTM

@exploreriii exploreriii merged commit f0e44d3 into hiero-ledger:main Jan 4, 2026
19 checks passed
@exploreriii
Copy link
Contributor Author

Thank you!

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]: Create beginner issue template

2 participants