Skip to content

Commit 2759538

Browse files
authored
Merge pull request #188 from exploreriii/templates-v2
Templates v2
2 parents a33ed4f + 119d47a commit 2759538

1 file changed

Lines changed: 59 additions & 16 deletions

File tree

.github/ISSUE_TEMPLATE/02_good_first_issue.yml

Lines changed: 59 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,43 @@ body:
1313
We truly appreciate your time and effort, welcome!.
1414
This template is designed to help you create a Good First Issue (GFI) : a small, well-scoped task that helps new contributors learn the codebase and workflow.
1515
---
16+
1617
- type: textarea
1718
id: intro
1819
attributes:
1920
label: 🆕🐥 Newcomer Friendly
2021
description: Who is this issue for?
2122
value: |
22-
Welcome 👋
23+
This **Good First Issue** is a guided, well-scoped task intended for new contributors to the Hiero Python SDK.
24+
25+
It is designed to help you:
26+
- understand how the repository is structured
27+
- practice the standard contribution workflow
28+
- submit and merge a pull request
2329
24-
This **Good First Issue** is a beginner-friendly starting point for the Hiero Python SDK.
30+
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
31+
Familiarity with **basic Python** and **Git** is sufficient.
2532
26-
You don’t need any background in:
27-
- Hiero or Hedera
28-
- distributed ledger technology
33+
A maintainer or mentor actively monitors this issue and will help guide it to completion.
2934
30-
If you’re comfortable with **basic Python** and **Git**, you’re ready to get started.
35+
⏱️ **Typical time to complete:** 30–90 minutes (once setup is done)
36+
🧩 **Difficulty:** Small, well-contained change
37+
🎓 **Best for:** New contributors
38+
39+
- type: textarea
40+
id: getting_help
41+
attributes:
42+
label: 🧭 Getting help if you’re stuck
43+
description: How to get support while working on this issue.
44+
value: |
45+
If you run into questions or get blocked, don’t spend more than **20 minutes** stuck on your own.
46+
47+
You can:
48+
- comment on this issue and tag `@good_first_issue_support_team` or `@mentor_name`
49+
- ask for help in [Discord](docs/discord.md)
50+
51+
Getting stuck and reaching out for help is a normal part of the contribution process.
52+
Even partial progress or draft pull requests are welcome!
3153
3254
- type: markdown
3355
attributes:
@@ -54,9 +76,12 @@ body:
5476
label: 👾 Issue description
5577
description: |
5678
Describe the issue in a way that’s easy for new contributors to understand.
79+
Briefly explain why this change is useful or needed, even if the impact seems small.
5780
Please avoid assuming prior knowledge of the language, codebase, or Hiero, as Good First Issues are often surfaced to new developers.
5881
Links to relevant documentation or code are very welcome.
5982
value: |
83+
This issue addresses a small but real improvement needed at the Hiero Python SDK.
84+
6085
Edit here. Example provided below.
6186
validations:
6287
required: true
@@ -229,7 +254,7 @@ body:
229254
230255
- [ ] **Connect** origin with upstream: [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
231256
232-
- [ ] **Install Packages** Install packages and protobuffs: [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
257+
- [ ] **Install Packages** and protobuffs: [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
233258
234259
- [ ] **Sync Main** pull any recent upstream changes: [Guide](docs/sdk_developers/rebasing.md)
235260
@@ -252,6 +277,8 @@ body:
252277
253278
- [ ] **Sync with main:** pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md)
254279
280+
- [ ] 💡 Tip: Before coding, leave a short comment describing what you plan to change. We’ll confirm you’re on the right track.
281+
255282
#### 🛠️ Solve the Issue
256283
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md)
257284
@@ -266,7 +293,9 @@ body:
266293
267294
- [ ] **Open a pull request:** [here](https://github.com/hiero-ledger/hiero-sdk-python/pulls) [guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md)
268295
269-
- [ ] **Complete the PR description:** briefly describe your changes and link the issue, [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md)
296+
- [ ] **Complete the PR description:** briefly describe your changes, [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md)
297+
298+
- [ ] **Link the Issue:** link the issue the PR solves in the PR description, [Guide](docs/sdk_developers/how_to_link_issues.md)
270299
271300
- [ ] **Submit the pull request:** click `**Create pull request**` 🎉
272301
@@ -316,11 +345,13 @@ body:
316345
- point out potential issues
317346
- suggest improvements or alternatives
318347
319-
AI feedback is **advisory** — it can make mistakes - use what’s helpful and feel free to ask questions.
348+
AI feedback is **advisory** — it can make mistakes - use what’s helpful and relevant to the issue description.
320349
321350
322-
#### 👀 Maintainer review
351+
#### 😎 Team Member review
323352
A Python SDK team member will review your PR, typically within **1–3 days**.
353+
Reviews focus on clarity and learning, and do not expect perfection.
354+
324355
- You may be asked to make changes, or
325356
- Your PR may be approved as-is ✅
326357
@@ -335,6 +366,14 @@ body:
335366
- **Other conflicts**
336367
More complex conflicts may require rebasing your branch and resolving them locally.
337368
👉 Follow the step-by-step **[Rebasing Guide](docs/sdk_developers/rebasing.md)** for help.
369+
370+
### 🏁 What success looks like
371+
372+
When this issue is complete, you will have:
373+
✅ Solved a real issue we need resolving
374+
✅ a merged pull request in the Hiero Python SDK
375+
✅ your name permanently in the project history
376+
✅ confidence to take on larger issues next
338377
validations:
339378
required: true
340379

@@ -356,9 +395,9 @@ body:
356395
- [Project Structure](docs/sdk_developers/training/setup/project_structure.md)
357396
- [DCO and Verified Signing Guide](docs/sdk_developers/signing.md)
358397
- [Changelog Guide](docs/sdk_developers/changelog_entry.md)
398+
- [Rebasing Guide](docs/sdk_developers/rebasing.md)
359399
- [Merge Conflicts Guide](docs/sdk_developers/merge_conflicts.md)
360400
- [Linking Issues Guide](docs/sdk_developers/how_to_link_issues.md)
361-
- [Rebasing Guide](docs/sdk_developers/rebasing.md)
362401
- [Workflow Guide](docs/sdk_developers/workflow.md)
363402
364403
- [Pin Github Actions Guide](docs/sdk_developers/how-to-pin-github-actions.md)
@@ -380,10 +419,14 @@ body:
380419
value: |
381420
You’re welcome to use AI tools while working on this issue.
382421
422+
Many contributors do — especially for:
423+
- understanding unfamiliar code
424+
- drafting small refactors
425+
- sanity-checking approaches
426+
383427
**Use AI responsibly:**
384-
- Verify suggestions before applying them, such as by looking at similar examples
385-
- Work one small change at a time
386-
- Create small tests/checks as you go
428+
- review suggestions carefully
429+
- apply changes incrementally
430+
- test as you go
387431
388-
**For Hiero Python SDK expert guidance:**
389-
- Ask a mentor/maintainer, they are happy to guide you on our best practices
432+
If in doubt, ask — maintainers are happy to help.

0 commit comments

Comments
 (0)