Skip to content

Commit 241379f

Browse files
authored
Merge pull request #184 from exploreriii/templates-v2
Templates v2
2 parents 683629f + f50f398 commit 241379f

1 file changed

Lines changed: 77 additions & 46 deletions

File tree

.github/ISSUE_TEMPLATE/02_good_first_issue.yml

Lines changed: 77 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,15 @@ body:
1919
label: 🆕🐥 Newcomer Friendly
2020
description: Who is this issue for?
2121
value: |
22-
Welcome 👋!
23-
This [Good First Issue](https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Ahiero-ledger+archived%3Afalse+label%3A%22good+first+issue%22+) is friendly to newcomers to the Hiero Python SDK.
24-
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
25-
Basic familiarity with Python and Git is enough.
22+
Welcome 👋
23+
24+
This **Good First Issue** is a beginner-friendly starting point for the Hiero Python SDK.
25+
26+
You don’t need any background in:
27+
- Hiero or Hedera
28+
- distributed ledger technology
29+
30+
If you’re comfortable with **basic Python** and **Git**, you’re ready to get started.
2631
2732
- type: markdown
2833
attributes:
@@ -210,28 +215,25 @@ body:
210215
label: 📋 Step-by-Step Setup Guide
211216
description: Provide a step-by-step setup guide for new contributors
212217
value: |
213-
Please follow these steps to setup:
214-
### Suggested Pre-requisites
215-
216-
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
217-
218-
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
219-
220-
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md)
221-
222-
- [ ] Create a GPG key linked to GitHub [Guide](docs/sdk_developers/signing.md)
218+
### Suggestions:
219+
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
220+
221+
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
222+
223+
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md).
224+
225+
- [ ] Create a GPG key linked to GitHub [Guide](docs/sdk_developers/signing.md).
223226
224227
### Setup the Hiero Python SDK for development
225-
226-
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md)
227-
228-
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
229-
230-
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
231-
232-
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md)
233-
234-
That's it! 🎉 We are ready to get started.
228+
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md).
229+
230+
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md).
231+
232+
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md).
233+
234+
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md).
235+
236+
You are set up! 🎉
235237
validations:
236238
required: true
237239

@@ -241,34 +243,32 @@ body:
241243
label: 📋 Step-by-step contribution guide
242244
description: Provide a contribution workflow suitable for new contributors.
243245
value: |
244-
Please follow these steps to contribute:
245-
246246
### ✅ Get ready
247-
- [ ] **Claim the issue:** Comment `/assign` [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md)
247+
- [ ] **Claim the issue:** Comment `/assign` [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md).
248248
249249
- [ ] **Double check the Issue and AI plan:**. Carefully re-read the issue description and the CodeRabbit AI plan.
250250
251-
- [ ] **Ask questions early:**. Ask on [Discord](docs/discord.md), your mentor (Python SDK help) or the `@good_first_issue_support_team` (setup help)
251+
- [ ] **Ask questions early:** Ask on [Discord](docs/discord.md), your `@mentor` (Python SDK help) and the `@good_first_issue_support_team` (setup and workflow help).
252252
253-
- [ ] **Sync with main:**. Pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md)
253+
- [ ] **Sync with main:** Pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md).
254254
255255
### 🛠️ Solve the Issue
256-
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md)
256+
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md).
257257
258-
- [ ] **Implement the solution**
258+
- [ ] **Implement the solution**: Follow the implementation steps in the issue description.
259259
260-
- [ ] **Commit with DCO and GPG signing:** Commit your changes using: `git commit -S -s -m "chore: your message"` [Guide](docs/sdk_developers/signing.md)
260+
- [ ] **Commit with DCO and GPG signing:** Commit changes using: `git commit -S -s -m "chore: your message"` [Guide](docs/sdk_developers/signing.md).
261261
262-
- [ ] **Add a `.CHANGELOG.md` entry:** under the appropriate **[UNRELEASED]** section and `git commit -S -s -m "chore: changelog entry"` [Guide](docs/sdk_developers/changelog_entry.md)
262+
- [ ] **Add a `.CHANGELOG.md` entry:** under the appropriate **[UNRELEASED]** section and commit as `git commit -S -s -m "chore: changelog entry"` [Guide](docs/sdk_developers/changelog_entry.md).
263263
264264
### 🚀 Create the pull request
265265
- [ ] **Push your commits:** Push your branch to your fork `git push origin your-branch-name`.
266266
267-
- [ ] **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)
267+
- [ ] **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).
268268
269269
- [ ] **Complete the PR description:** Briefly describe your changes and link the issue [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md).
270270
271-
- [ ] **Submit the pull request:** Click **Create pull request** 🎉
271+
- [ ] **Submit the pull request:** Click `**Create pull request**` 🎉.
272272
273273
validations:
274274
required: true
@@ -279,18 +279,42 @@ body:
279279
label: 🤔 What to expect after submitting a PR
280280
description: Explain what happens after a pull request is opened.
281281
value: |
282-
Once you open a pull request, a few automated checks will run that will all need to pass (signing, changelog, tests, examples, and code quality). Open each test result to see details.
282+
Once you open a pull request, here’s what happens next:
283+
284+
### 🤖 Automated checks
285+
A few automated checks will run and **all must pass** before your PR can be merged, such as:
286+
- signing
287+
- changelog entry
288+
- solo unit and integration tests
289+
- examples
290+
- code quality checks
291+
292+
👉 You can open each check to see detailed results and error messages if anything fails.
293+
294+
### 🤝 AI feedback (CodeRabbit)
295+
You’ll receive quick feedback from **CodeRabbit AI**, which may:
296+
- point out potential issues
297+
- suggest improvements or alternatives
283298
284-
You’ll also get quick feedback from CodeRabbit AI, which may point out issues or suggest improvements. AI feedback is advisory—use what’s helpful.
299+
AI feedback is **advisory** — it can make mistakes - use what’s helpful and feel free to ask questions.
285300
286-
A Python SDK team member will review your PR, usually within 1–3 days. You may be asked to make changes or your PR may be approved.
301+
### 👀 Maintainer review
302+
A Python SDK team member will review your PR, typically within **1–3 days**.
303+
- You may be asked to make changes, or
304+
- Your PR may be approved as-is ✅
287305
288-
After approval, PRs are typically merged within a day.
306+
### 🚀 Merge
307+
Once approved, PRs are usually merged within **one day**.
289308
290-
🔄 Merge conflicts
291-
Merge conflicts can happen as the SDK updates:
292-
- Changelog conflicts: use the online editor in the PR
293-
- Other conflicts may require rebasing and manual resolution [Guide](docs/sdk_developers/rebasing.md)
309+
### 🔄 Merge conflicts
310+
Merge conflicts can occasionally happen as the SDK updates. This is normal and fixable.
311+
312+
- **Changelog conflicts**
313+
These are common and can usually be resolved directly using GitHub’s online editor in the pull request.
314+
315+
- **Other conflicts**
316+
More complex conflicts may require rebasing your branch and resolving them locally.
317+
👉 Follow the step-by-step **[Rebasing Guide](docs/sdk_developers/rebasing.md)** for help.
294318
validations:
295319
required: true
296320

@@ -333,6 +357,8 @@ body:
333357
description: |
334358
Edit or expand this checklist with what is required to merge a pull request for this issue.
335359
value: |
360+
To be able to close this issue, the following criteria must be met:
361+
336362
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements.
337363
338364
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue.
@@ -349,7 +375,12 @@ body:
349375
label: 🤖 AI usage guidelines
350376
description: Guidance on using AI tools responsibly for this issue.
351377
value: |
352-
You’re welcome to use AI tools responsibly while working on this issue.
353-
Please review suggestions carefully, build step by step, and test changes as you go.
378+
You’re welcome to use AI tools while working on this issue.
379+
380+
**Use AI responsibly:**
381+
- Verify suggestions before applying them, such as by looking at similar examples
382+
- Work one small change at a time
383+
- Create small tests/checks as you go
354384
355-
If anything’s unclear, a mentor or maintainer is happy to help.
385+
**For Hiero Python SDK expert guidance:**
386+
- Ask a mentor/maintainer, they are happy to guide you on our best practices

0 commit comments

Comments
 (0)