Skip to content

Commit 683629f

Browse files
authored
Merge pull request #182 from exploreriii/templates-v2
Templates v2
2 parents 21acef3 + d501a7c commit 683629f

1 file changed

Lines changed: 49 additions & 61 deletions

File tree

.github/ISSUE_TEMPLATE/02_good_first_issue.yml

Lines changed: 49 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ body:
2020
description: Who is this issue for?
2121
value: |
2222
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 especially friendly to newcomers to the Hiero Python SDK.
24-
25-
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required and basic familiarity with Python and Git is enough.
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.
2626
2727
- type: markdown
2828
attributes:
@@ -211,17 +211,27 @@ body:
211211
description: Provide a step-by-step setup guide for new contributors
212212
value: |
213213
Please follow these steps to setup:
214-
- [ ] **Suggested Pre-requisites**
215-
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
216-
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
217-
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md)
218-
- [ ] Create a GPG key and tie it to GitHub (Guide)[docs/sdk_developers/signing.md]
219-
- [ ] **Setup the Hiero Python SDK for development**
220-
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md)
221-
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
222-
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
223-
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md)
224-
That's it! We are ready to get started.
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)
223+
224+
### 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.
225235
validations:
226236
required: true
227237

@@ -234,50 +244,32 @@ body:
234244
Please follow these steps to contribute:
235245
236246
### ✅ Get ready
237-
- [ ] **Claim the issue:**
238-
Comment on the issue to get assigned.
239-
[Assignment guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/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)
240248
241-
- [ ] **Read the issue carefully:**
242-
Review the issue description and the CodeRabbit AI plan.
249+
- [ ] **Double check the Issue and AI plan:**. Carefully re-read the issue description and the CodeRabbit AI plan.
243250
244-
- [ ] **Ask questions early:**
245-
Reach out on [Discord](docs/discord.md) or to your mentor for implementation questions, or comment with `@good_first_issue_support_team` for setup or workflow help.
251+
- [ ] **Ask questions early:**. Ask on [Discord](docs/discord.md), your mentor (Python SDK help) or the `@good_first_issue_support_team` (setup help)
246252
247-
- [ ] **Sync with main:**
248-
Pull the latest upstream changes.
249-
[Rebasing guide](docs/sdk_developers/rebasing.md)
253+
- [ ] **Sync with main:**. Pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md)
250254
251-
### 🛠️ Start solving the issue
252-
- [ ] **Create a branch from `main`:**
253-
Create a working branch for your changes.
254-
[Branching guide](docs/sdk_developers/training/workflow/05_working_branches.md)
255+
### 🛠️ Solve the Issue
256+
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md)
255257
256-
- [ ] **Work on the solution:**
257-
Implement the changes described in the issue.
258+
- [ ] **Implement the solution**
258259
259-
- [ ] **Commit with DCO and GPG signing:**
260-
Commit your changes using:
261-
`git commit -S -s -m "chore: your message"`
262-
[Signing guide](docs/sdk_developers/signing.md)
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)
263261
264-
- [ ] **Add a changelog entry:**
265-
Add an entry to `.CHANGELOG.md` under the appropriate **[UNRELEASED]** section and commit it separately.
266-
[Changelog guide](docs/sdk_developers/changelog_entry.md)
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)
267263
268264
### 🚀 Create the pull request
269-
- [ ] **Push your commits:**
270-
Push your branch to your fork (e.g. `git push origin your-branch-name`).
265+
- [ ] **Push your commits:** Push your branch to your fork `git push origin your-branch-name`.
266+
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)
271268
272-
- [ ] **Open a pull request:**
273-
Create a pull request [here](https://github.com/hiero-ledger/hiero-sdk-python/pulls).
274-
[Pull request guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md)
269+
- [ ] **Complete the PR description:** Briefly describe your changes and link the issue [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md).
275270
276-
- [ ] **Complete the PR description:**
277-
Briefly describe your changes and link the issue being resolved [Linking Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md).
271+
- [ ] **Submit the pull request:** Click **Create pull request** 🎉
278272
279-
- [ ] **Submit the pull request:**
280-
Click **Create pull request** 🎉
281273
validations:
282274
required: true
283275

@@ -287,11 +279,11 @@ body:
287279
label: 🤔 What to expect after submitting a PR
288280
description: Explain what happens after a pull request is opened.
289281
value: |
290-
Once you open a pull request, a few automated checks will run (signing, changelog, tests, examples, and code quality).
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.
291283
292284
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.
293285
294-
A Python SDK team member will review your PR next, usually within 1–3 days. You may be asked to make changes or your PR may be approved.
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.
295287
296288
After approval, PRs are typically merged within a day.
297289
@@ -308,13 +300,13 @@ body:
308300
label: 🤔 Additional Help
309301
description: Provide any extra resources or context for contributors to solve this good first issue
310302
value: |
311-
###First Points of Contact:
303+
### First Points of Contact:
312304
- [Discord](docs/discord.md)
313-
- Comment with your `@mentor_name` (for Python SDK questions)
305+
- Comment with `@mentor_name` (for Python SDK questions)
314306
- Comment with `@hiero-ledger/hiero-sdk-good-first-issue-support` (for setup and workflow questions)
315307
The more you ask, the more you learn and so do we!
316308
317-
###Helpful Documentation:
309+
### Documentation:
318310
- [Project Structure](docs/sdk_developers/training/setup/project_structure.md)
319311
- [DCO and Verified Signing Guide](docs/sdk_developers/signing.md)
320312
- [Changelog Guide](docs/sdk_developers/changelog_entry.md)
@@ -330,7 +322,7 @@ body:
330322
- [General Training](docs/sdk_developers/training)
331323
- [General SDK Developer Docs](docs/sdk_developers)
332324
333-
###Helpful Calls:
325+
### Calls:
334326
- Get hands-on-help by our expert team at our [Office Hours](https://zoom-lfx.platform.linuxfoundation.org/meeting/99912667426?password=5b584a0e-1ed7-49d3-b2fc-dc5ddc888338)
335327
- Learn, raise issues and provide feedback at [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meeting/92041330205?password=2f345bee-0c14-4dd5-9883-06fbc9c60581)
336328
@@ -341,17 +333,13 @@ body:
341333
description: |
342334
Edit or expand this checklist with what is required to merge a pull request for this issue.
343335
value: |
344-
- [ ] **The issue is solved:**
345-
I’ve carefully read and implemented the issue requirements.
336+
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements.
346337
347-
- [ ] **I did not add extra changes:**
348-
I did not modify anything beyond what is described in the issue.
338+
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue.
349339
350-
- [ ] **Behavior:**
351-
All other existing features continue to work as before.
340+
- [ ] **Behavior:** All other existing features continue to work as before.
352341
353-
- [ ] **Checks and feedback:**
354-
All automated checks pass and any requested feedback has been addressed.
342+
- [ ] **Checks and feedback:** All checks pass and any requested changes have been made.
355343
validations:
356344
required: true
357345

@@ -361,7 +349,7 @@ body:
361349
label: 🤖 AI usage guidelines
362350
description: Guidance on using AI tools responsibly for this issue.
363351
value: |
364-
You’re welcome to use AI tools while working on this issue.
352+
You’re welcome to use AI tools responsibly while working on this issue.
365353
Please review suggestions carefully, build step by step, and test changes as you go.
366354
367355
If anything’s unclear, a mentor or maintainer is happy to help.

0 commit comments

Comments
 (0)