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
+57-42Lines changed: 57 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -20,14 +20,16 @@ body:
20
20
label: ๐๐ฅ Newcomer Friendly
21
21
description: Who is this issue for?
22
22
value: |
23
+
#### Overview
23
24
This **[Good First Issue](https://github.com/hiero-ledger/hiero-sdk-python/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22Good%20First%20Issue%22%20no%3Aassignee)** is a guided, well-scoped task intended for new contributors to the Hiero Python SDK.
24
25
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
26
+
#### What youโll do
27
+
- โ understand how the repository is structured
28
+
- โ practice the standard contribution workflow
29
+
- โ submit and merge a pull request
29
30
30
-
A maintainer or mentor actively monitors this issue and will help guide it to completion.
31
+
#### Support
32
+
A maintainer or mentor actively monitors this issue and will help **guide it to completion**.
31
33
32
34
> [!IMPORTANT]
33
35
> **This issue does not require prior domain knowledge.**
@@ -36,9 +38,10 @@ body:
36
38
> - No distributed ledger background required
37
39
> - **Basic Python and Git are sufficient**
38
40
39
-
โฑ๏ธ **Typical time to complete:** 30โ90 minutes (once setup is done)
40
-
๐งฉ **Difficulty:** Small, well-contained change
41
-
๐ **Best for:** New contributors
41
+
> [!NOTE]
42
+
> โฑ๏ธ **Typical time to complete:** 30โ90 minutes (once setup is done)
For good first issues, please keep this as guided and clear as possible.
185
188
value: |
186
189
Edit here. Example provided below.
190
+
191
+
---
187
192
validations:
188
193
required: true
189
194
@@ -316,68 +321,78 @@ body:
316
321
label: ๐งญ Getting help if youโre stuck
317
322
description: How to get support while working on this issue.
318
323
value: |
319
-
If you run into questions or get blocked, donโt spend more than **20 minutes** stuck on your own.
324
+
If questions come up, donโt spend more than **20 minutes** blocked.
320
325
321
-
You can:
322
-
- comment on this issue and tag `@good_first_issue_support_team` or `@mentor_name`
323
-
- ask for help in [Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md)
326
+
### Ways to get help
327
+
- Comment on this issue and tag `@good_first_issue_support_team` or `@mentor_name`
328
+
- Ask in [Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md)
324
329
325
-
Getting stuck and reaching out for help is a normal part of the contribution process.
326
-
Even partial progress or draft pull requests are welcome!
330
+
Reaching out early is part of the contribution process.
331
+
Draft pull requests and partial progress are welcome.
327
332
328
333
- type: textarea
329
334
id: pr_expectations
330
335
attributes:
331
336
label: ๐ค What to expect after submitting a PR
332
337
description: Explain what happens after a pull request is opened.
333
338
value: |
334
-
Once you open a pull request, hereโs what happens next:
339
+
Once you open a pull request, hereโs what happens next.
340
+
341
+
---
342
+
343
+
**๐ค Automated checks**
344
+
Before your PR can be merged, a small set of automated checks must pass:
335
345
336
-
#### ๐ค Automated checks
337
-
A few automated checks will run and **all must pass** before your PR can be merged, such as:
338
-
- signing
339
-
- changelog entry
340
-
- solo unit and integration tests
341
-
- examples
342
-
- code quality checks
346
+
- Signing
347
+
- Changelog entry
348
+
- Unit and integration tests
349
+
- Examples
350
+
- Code quality checks
343
351
344
-
๐ You can open each check to see detailed results and error messages if anything fails.
352
+
You can open each check to see detailed results if something fails.
345
353
354
+
---
346
355
347
-
#### ๐ค AI feedback (CodeRabbit)
348
-
Youโll receive quick feedback from **CodeRabbit AI**, which may:
349
-
- point out potential issues
350
-
- suggest improvements or alternatives
356
+
**๐ค AI feedback (CodeRabbit)**
357
+
CodeRabbit AI may leave early feedback on your PR, including:
358
+
- potential issues
359
+
- suggested improvements or alternatives
351
360
352
-
AI feedback is **advisory** โ it can make mistakes - use whatโs helpful and relevant to the issue description.
361
+
AI feedback is advisory. Use whatโs helpful.
353
362
363
+
---
354
364
355
-
#### ๐ Team Member review
365
+
**๐ Team review**
356
366
A Python SDK team member will review your PR, typically within **1โ3 days**.
357
-
Reviews focus on clarity and learning.
358
367
359
-
- You may be asked to make changes, or
360
-
- Your PR may be approved as-is โ
368
+
Reviews focus on clarity and learning:
369
+
- you may be asked to make changes, or
370
+
- your PR may be approved as-is โ
361
371
362
372
Once approved, PRs are usually merged within **one day**.
363
373
364
-
#### ๐ Merge conflicts
365
-
Merge conflicts can occasionally happen as the SDK updates. This is normal and fixable.
374
+
---
375
+
376
+
**๐ Merge conflicts**
377
+
Merge conflicts can occasionally happen as the SDK updates.
366
378
367
379
- **Changelog conflicts**
368
-
These are common and can usually be resolved by accepting both changes using GitHubโs online editor in the pull request.
380
+
Usually resolved by accepting both changes in GitHubโs online editor.
369
381
370
382
- **Other conflicts**
371
-
More complex conflicts may require rebasing your branch and resolving them locally.
372
-
๐ Follow the step-by-step **[Rebasing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md)** for help.
383
+
May require rebasing your branch locally.
384
+
๐ Follow the **[Rebasing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md)**.
373
385
374
-
### ๐ What success looks like
386
+
---
375
387
388
+
**๐ What success looks like**
376
389
When this issue is complete, you will have:
377
-
โ Solved a real issue we need resolving
378
-
โ a merged pull request in the Hiero Python SDK
379
-
โ your name permanently in the project history
380
-
โ confidence to take on larger issues next
390
+
391
+
- โ Solved a real issue we needed
392
+
- โ A merged pull request in the Hiero Python SDK
0 commit comments