You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/02_good_first_issue.yml
+52-11Lines changed: 52 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -13,21 +13,43 @@ body:
13
13
We truly appreciate your time and effort, welcome!.
14
14
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.
15
15
---
16
+
16
17
- type: textarea
17
18
id: intro
18
19
attributes:
19
20
label: 🆕🐥 Newcomer Friendly
20
21
description: Who is this issue for?
21
22
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
29
+
30
+
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
31
+
Familiarity with **basic Python** and **Git** is sufficient.
32
+
33
+
A maintainer or mentor actively monitors this issue and will help guide it to completion.
23
34
24
-
This **Good First Issue** is a beginner-friendly starting point for the Hiero Python SDK.
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.
25
46
26
-
You don’t need any background in:
27
-
- Hiero or Hedera
28
-
- distributed ledger technology
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)
29
50
30
-
If you have **basic Python** and **Git**, you’re ready to get started.
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!
31
53
32
54
- type: markdown
33
55
attributes:
@@ -54,9 +76,12 @@ body:
54
76
label: 👾 Issue description
55
77
description: |
56
78
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.
57
80
Please avoid assuming prior knowledge of the language, codebase, or Hiero, as Good First Issues are often surfaced to new developers.
58
81
Links to relevant documentation or code are very welcome.
59
82
value: |
83
+
This issue addresses a small but real improvement needed at the Hiero Python SDK.
84
+
60
85
Edit here. Example provided below.
61
86
validations:
62
87
required: true
@@ -252,6 +277,8 @@ body:
252
277
253
278
- [ ] **Sync with main:** pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md)
254
279
280
+
- [ ] 💡 Tip: Before coding, leave a short comment describing what you plan to change. We’ll confirm you’re on the right track.
281
+
255
282
#### 🛠️ Solve the Issue
256
283
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md)
257
284
@@ -323,6 +350,8 @@ body:
323
350
324
351
#### 😎 Team Member review
325
352
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
+
326
355
- You may be asked to make changes, or
327
356
- Your PR may be approved as-is ✅
328
357
@@ -337,6 +366,14 @@ body:
337
366
- **Other conflicts**
338
367
More complex conflicts may require rebasing your branch and resolving them locally.
339
368
👉 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
340
377
validations:
341
378
required: true
342
379
@@ -382,10 +419,14 @@ body:
382
419
value: |
383
420
You’re welcome to use AI tools while working on this issue.
384
421
422
+
Many contributors do — especially for:
423
+
- understanding unfamiliar code
424
+
- drafting small refactors
425
+
- sanity-checking approaches
426
+
385
427
**Use AI responsibly:**
386
-
- Verify suggestions before applying them, such as by looking at similar examples
387
-
- Work one small change at a time
388
-
- Create small tests/checks as you go
428
+
- review suggestions carefully
429
+
- apply changes incrementally
430
+
- test as you go
389
431
390
-
**For Hiero Python SDK expert guidance:**
391
-
- Ask a mentor/maintainer, they are happy to guide you on our best practices
0 commit comments