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
+59-16Lines changed: 59 additions & 16 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
23
29
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.
25
32
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.
29
34
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!
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
@@ -229,7 +254,7 @@ body:
229
254
230
255
- [ ] **Connect** origin with upstream: [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
231
256
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)
- [ ] **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
@@ -266,7 +293,9 @@ body:
266
293
267
294
- [ ] **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)
268
295
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)
0 commit comments