Skip to content

Commit 53bdfd8

Browse files
authored
Merge pull request #194 from exploreriii/templates-v2
chore: less flooded attempt
2 parents 3e81425 + 9140808 commit 53bdfd8

1 file changed

Lines changed: 57 additions & 42 deletions

File tree

โ€Ž.github/ISSUE_TEMPLATE/02_good_first_issue.ymlโ€Ž

Lines changed: 57 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,16 @@ body:
2020
label: ๐Ÿ†•๐Ÿฅ Newcomer Friendly
2121
description: Who is this issue for?
2222
value: |
23+
#### Overview
2324
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.
2425
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
2930
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**.
3133
3234
> [!IMPORTANT]
3335
> **This issue does not require prior domain knowledge.**
@@ -36,9 +38,10 @@ body:
3638
> - No distributed ledger background required
3739
> - **Basic Python and Git are sufficient**
3840
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)
43+
> ๐Ÿงฉ **Difficulty:** Small, well-contained change
44+
> ๐ŸŽ“ **Best for:** New contributors
4245
4346
- type: markdown
4447
attributes:
@@ -184,6 +187,8 @@ body:
184187
For good first issues, please keep this as guided and clear as possible.
185188
value: |
186189
Edit here. Example provided below.
190+
191+
---
187192
validations:
188193
required: true
189194

@@ -316,68 +321,78 @@ body:
316321
label: ๐Ÿงญ Getting help if youโ€™re stuck
317322
description: How to get support while working on this issue.
318323
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.
320325
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)
324329
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.
327332
328333
- type: textarea
329334
id: pr_expectations
330335
attributes:
331336
label: ๐Ÿค” What to expect after submitting a PR
332337
description: Explain what happens after a pull request is opened.
333338
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:
335345
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
343351
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.
345353
354+
---
346355
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
351360
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.
353362
363+
---
354364
355-
#### ๐Ÿ˜Ž Team Member review
365+
**๐Ÿ˜Ž Team review**
356366
A Python SDK team member will review your PR, typically within **1โ€“3 days**.
357-
Reviews focus on clarity and learning.
358367
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 โœ…
361371
362372
Once approved, PRs are usually merged within **one day**.
363373
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.
366378
367379
- **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.
369381
370382
- **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)**.
373385
374-
### ๐Ÿ What success looks like
386+
---
375387
388+
**๐Ÿ What success looks like**
376389
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
393+
- โœ… Your name in the project history
394+
- โœ… Confidence to take on larger issues next
395+
381396
validations:
382397
required: true
383398

0 commit comments

Comments
ย (0)