fix: redesign beginner issue template to improve completion rates

[cheese-cakee]

Summary

Redesigns the beginner issue template (03_beginner_issue.yml) with a structurally distinct approach to address the lowest completion rate of any issue type.

This is a fresh rewrite . The previous attempt (#1659) was closed after review feedback identified structural issues.

What changed

• Readiness self-check at the top so contributors can assess whether they are ready before claiming
• Single "The Task" section replaces the three-section Description / Solution / Implementation Steps split used in GFI
• "Where to Start" exploration pointers replace step-by-step recipes — encourages independent investigation
• Compact workflow quick-reference table (6 rows) replaces the 15-item tutorial checklist
• Common pitfalls section with direct warnings based on real beginner PR failure patterns (scope creep, unsigned commits, skipped changelog, blind AI usage, going silent when stuck)
• External Python documentation links (official docs, data model, type hints) alongside project references
• All links converted to absolute URLs so they render correctly in GitHub issues
• AI guidance folded into pitfalls — no standalone AI section at this level
• Issue creator guidance in description: fields coaches maintainers on calibrating "slightly challenging"

What was removed (intentionally)

Removed	Why
Intro textarea ("Beginner Friendly")	Replaced by readiness self-check
Beginner Guidelines markdown	Creator guidance moved to header; link to guidelines doc preserved
Proposed Solution textarea	Merged into "The Task"
Implementation Steps textarea	Replaced by "Where to Start"
Step-by-Step Contribution Guide	Replaced by compact workflow table
AI Usage Guidelines textarea	Folded into Common Pitfalls

Structural comparison

	GFI	New Beginner	Intermediate
Editable textareas	9	4	5
Readiness check	No	Yes	No
Setup guide	Yes	No	No
Step-by-step workflow	Yes (15+ items)	No (6-row table)	No
Exploration pointers	No	Yes	Similar
Common pitfalls	No	Yes	No
External Python refs	No	Yes	No

Resolves #1651

[coderabbitai]

Walkthrough

Reworks the Beginner Issue GitHub template into a guidance-focused layout: updates intro wording and placement, renames several sections (e.g., issue→task), replaces prescriptive steps with exploration-oriented prompts and examples, adds AI usage tips, resources with absolute URLs, and updates CHANGELOG entry referencing #1651. (50 words)

Changes

Cohort / File(s)	Summary
Beginner Issue Template Redesign .github/ISSUE_TEMPLATE/03_beginner_issue.yml	Full rewrite of the Beginner Issue template: moved and reworded intro; renamed fields (intro removed, issue → task); replaced step-by-step instructions with "Where to start" exploration prompts; reorganized sections into Background Research, Implementation, Done Checklist, Workflow quick reference; added AI guidance, tips, examples, and Resources requiring absolute URLs.
Changelog Documentation CHANGELOG.md	Added changelog entry noting the beginner issue template redesign (readiness self-check, exploration-based structure, compact workflow reference, common pitfalls) tied to issue #1651.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: redesigning the beginner issue template to address low completion rates, which directly matches the primary objective of the PR.
Description check	✅ Passed	The description is comprehensive and directly related to the changeset, explaining what was redesigned, what changed, what was removed, and how the new template differs from other templates.
Linked Issues check	✅ Passed	The PR addresses all major requirements from #1651: a bespoke beginner template with readiness self-check, exploration pointers, compact workflow table, common pitfalls section, external documentation links, and improved guidance—designed to increase completion rates.
Out of Scope Changes check	✅ Passed	All changes (03_beginner_issue.yml and CHANGELOG.md) are directly scoped to redesigning the beginner issue template as required by #1651; no unrelated modifications detected.
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
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

CHANGELOG.md (1)

146-153: ⚠️ Potential issue | 🟡 Minor

Duplicate "### Changed" section headers under [Unreleased].

There are two ### Changed sections under [Unreleased]: one at line 146 (with this new entry) and another at line 153. This violates the Keep a Changelog format where each section type should appear only once per release version. The new entry should be moved to the existing ### Changed section starting at line 153.

📝 Suggested fix to consolidate sections

Move line 147 to the existing ### Changed section (after line 153) and remove the duplicate header:

-### Changed
-- Redesigned beginner issue template with readiness self-check, exploration-based task structure, compact workflow reference, and common pitfalls guidance to improve completion rates (`#1651`)
-
 ### Documentation
 - Added comprehensive docstring to `compress_with_cryptography` function (`#1626`)
 - Replaced the docstring in `entity_id_helper.py` with one that is correct. (`#1623`)

 ### Changed
+- Redesigned beginner issue template with readiness self-check, exploration-based task structure, compact workflow reference, and common pitfalls guidance to improve completion rates (`#1651`)
 - Updated return of to_bytes function in `src/hiero_sdk_python/transaction/transaction.py`. (`#1631`)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##             main    #1729   +/-   ##
=======================================
  Coverage   93.18%   93.18%           
=======================================
  Files         140      140           
  Lines        8977     8977           
=======================================
  Hits         8365     8365           
  Misses        612      612           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR redesigns the beginner issue template to address the lowest completion rate among all issue types. The redesign shifts from a detailed step-by-step tutorial approach to an exploration-based model that encourages independent problem-solving while providing appropriate safety rails.

Changes:

• Replaced prescriptive multi-section structure with a streamlined 4-field template focused on self-assessment and exploration
• Added readiness self-check criteria and common pitfall warnings based on real failure patterns
• Consolidated workflow guidance into a compact reference table with links instead of verbose checklists

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
.github/ISSUE_TEMPLATE/03_beginner_issue.yml	Complete rewrite of beginner issue template with exploration-based structure, readiness checks, workflow quick-reference table, and practical pitfall warnings
CHANGELOG.md	Added entry documenting the template redesign under the Changed section

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[cheese-cakee]

ready for review ! @exploreriii @manishdait

[exploreriii]

Super awesome @cheese-cakee
I think you are getting really close to hitting the bullseye
I have a couple doubts with no clear solution, what do you think?

[exploreriii]

I think one sticking point that the title 'Good First Issue' doesn't do a good job...
is that most new starters will probably find the best fit at doing a few GFI

I think we somehow need to make that clear without being rules or condescending and make it normal that most people will require a few GFI before moving on to a beginner issue

also begginner issues are always different, so, some might be a better fit than others and could be agood entry point

[exploreriii]

Hi @cheese-cakee also i don't know how this renders, so my ideas might not be right in terms of adding new sections etc
Would definitely suggest mergign this to your fork's main, creating an issue and seeing it live

[cheese-cakee]

thankyou for such detailed review @exploreriii . I am trying to incorporate your suggestions and merge it to my fork's main and see what works best.

[coderabbitai]

Actionable comments posted: 2

[cheese-cakee]

to check how it renders please click on this link:

https://github.com/cheese-cakee/hiero-sdk-python/blob/fix/redesign-beginner-template/.github/ISSUE_TEMPLATE/03_beginner_issue.yml

[exploreriii]

I'd like to see how it renders posted as well as to the issue creator, you may have to merge it to your main

cheese-cakee#12

[exploreriii]

changed to draft please awaiting a final version of the published template 👍

[github-actions]

Hi, this is MergeConflictBot.
Your pull request cannot be merged because it contains merge conflicts.

Please resolve these conflicts locally and push the changes.

Quick Fix for CHANGELOG.md Conflicts

If your conflict is only in CHANGELOG.md, you can resolve it easily using the GitHub web editor:

1. Click on the "Resolve conflicts" button in the PR
2. Accept both changes (keep both changelog entries)
3. Click "Mark as resolved"
4. Commit the merge

For all other merge conflicts, please read:

• Resolving Merge Conflicts
• Rebasing Guide

Thank you for contributing!