Skip to content

Commit a33ed4f

Browse files
authored
Merge pull request #186 from exploreriii/templates-v2
chore: some tidy
2 parents 241379f + 29caa87 commit a33ed4f

1 file changed

Lines changed: 58 additions & 55 deletions

File tree

.github/ISSUE_TEMPLATE/02_good_first_issue.yml

Lines changed: 58 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ body:
3333
attributes:
3434
value: |
3535
> [!IMPORTANT]
36-
> ### 📋 Good First Issue (GFI) Guidelines
36+
> #### 📋 Good First Issue (GFI) Guidelines
3737
> A **Good First Issue [Guidelines](docs/maintainers/good_first_issue_candidate_guidelines.md)** is a small, well-scoped task that helps new contributors get familiar with the codebase and contribution workflow.
3838
>
3939
> **Often a good fit for Good First Issues:**
@@ -177,7 +177,7 @@ body:
177177
attributes:
178178
value: |
179179
<!-- Example implementation (hidden in submission) -->
180-
### 👩‍💻 Implementation - Example
180+
#### 👩‍💻 Implementation - Example
181181
182182
To break down the monolithic main function, you need to:
183183
- [ ] Extract the Key Steps (set up a client, create a test account, create a token, associate the token)
@@ -215,23 +215,23 @@ body:
215215
label: 📋 Step-by-Step Setup Guide
216216
description: Provide a step-by-step setup guide for new contributors
217217
value: |
218-
### Suggestions:
219-
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
218+
#### Suggestions:
219+
- [ ] Visual Studio (VS) Code: [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
220220
221-
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
221+
- [ ] GitHub Desktop: [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
222222
223-
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md).
223+
- [ ] Hedera Testnet Account with root .env file: [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md)
224224
225-
- [ ] Create a GPG key linked to GitHub [Guide](docs/sdk_developers/signing.md).
225+
- [ ] Create a GPG key linked to GitHub: [Guide](docs/sdk_developers/signing.md)
226226
227-
### Setup the Hiero Python SDK for development
228-
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md).
227+
#### Setup the Hiero Python SDK for development
228+
- [ ] **Fork** Create an online and local copy of the repository: [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md)
229229
230-
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md).
230+
- [ ] **Connect** origin with upstream: [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
231231
232-
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md).
232+
- [ ] **Install Packages** Install packages and protobuffs: [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
233233
234-
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md).
234+
- [ ] **Sync Main** pull any recent upstream changes: [Guide](docs/sdk_developers/rebasing.md)
235235
236236
You are set up! 🎉
237237
validations:
@@ -243,36 +243,55 @@ body:
243243
label: 📋 Step-by-step contribution guide
244244
description: Provide a contribution workflow suitable for new contributors.
245245
value: |
246-
### ✅ Get ready
247-
- [ ] **Claim the issue:** Comment `/assign` [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md).
246+
#### ✅ Get ready
247+
- [ ] **Claim the issue:** comment `/assign`: [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md)
248248
249-
- [ ] **Double check the Issue and AI plan:**. Carefully re-read 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
250250
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).
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
255-
### 🛠️ Solve the Issue
256-
- [ ] **Create a branch from `main`:** [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)
257257
258-
- [ ] **Implement the solution**: Follow the implementation steps in the issue description.
258+
- [ ] **Implement the solution**: follow the implementation steps in the issue description.
259259
260-
- [ ] **Commit with DCO and GPG signing:** Commit 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 commit as `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
264-
### 🚀 Create the pull request
265-
- [ ] **Push your commits:** Push your branch to your fork `git push origin your-branch-name`.
264+
#### 🚀 Create the pull request
265+
- [ ] **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
269-
- [ ] **Complete the PR description:** Briefly describe your changes and link the issue [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)
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
275275

276+
- type: textarea
277+
id: acceptance-criteria
278+
attributes:
279+
label: ✅ Acceptance criteria
280+
description: |
281+
Edit or expand this checklist with what is required to merge a pull request for this issue.
282+
value: |
283+
To be able to close this issue, the following criteria must be met:
284+
285+
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements
286+
287+
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue
288+
289+
- [ ] **Behavior:** All other existing features continue to work as before
290+
291+
- [ ] **Checks and feedback:** All checks pass and any requested changes have been made
292+
validations:
293+
required: true
294+
276295
- type: textarea
277296
id: pr_expectations
278297
attributes:
@@ -281,7 +300,7 @@ body:
281300
value: |
282301
Once you open a pull request, here’s what happens next:
283302
284-
### 🤖 Automated checks
303+
#### 🤖 Automated checks
285304
A few automated checks will run and **all must pass** before your PR can be merged, such as:
286305
- signing
287306
- changelog entry
@@ -291,26 +310,27 @@ body:
291310
292311
👉 You can open each check to see detailed results and error messages if anything fails.
293312
294-
### 🤝 AI feedback (CodeRabbit)
313+
314+
#### 🤝 AI feedback (CodeRabbit)
295315
You’ll receive quick feedback from **CodeRabbit AI**, which may:
296316
- point out potential issues
297317
- suggest improvements or alternatives
298318
299319
AI feedback is **advisory** — it can make mistakes - use what’s helpful and feel free to ask questions.
300320
301-
### 👀 Maintainer review
321+
322+
#### 👀 Maintainer review
302323
A Python SDK team member will review your PR, typically within **1–3 days**.
303324
- You may be asked to make changes, or
304325
- Your PR may be approved as-is ✅
305326
306-
### 🚀 Merge
307327
Once approved, PRs are usually merged within **one day**.
308328
309-
### 🔄 Merge conflicts
329+
#### 🔄 Merge conflicts
310330
Merge conflicts can occasionally happen as the SDK updates. This is normal and fixable.
311331
312332
- **Changelog conflicts**
313-
These are common and can usually be resolved directly using GitHub’s online editor in the pull request.
333+
These are common and can usually be resolved by accepting both changes using GitHub’s online editor in the pull request.
314334
315335
- **Other conflicts**
316336
More complex conflicts may require rebasing your branch and resolving them locally.
@@ -324,13 +344,15 @@ body:
324344
label: 🤔 Additional Help
325345
description: Provide any extra resources or context for contributors to solve this good first issue
326346
value: |
327-
### First Points of Contact:
347+
#### First Points of Contact:
328348
- [Discord](docs/discord.md)
329349
- Comment with `@mentor_name` (for Python SDK questions)
330350
- Comment with `@hiero-ledger/hiero-sdk-good-first-issue-support` (for setup and workflow questions)
331351
The more you ask, the more you learn and so do we!
332352
333-
### Documentation:
353+
#### Documentation:
354+
- [README.md](./README.md)
355+
- [CONTRIBUTING.md](./CONTRIBUTING.md)
334356
- [Project Structure](docs/sdk_developers/training/setup/project_structure.md)
335357
- [DCO and Verified Signing Guide](docs/sdk_developers/signing.md)
336358
- [Changelog Guide](docs/sdk_developers/changelog_entry.md)
@@ -346,29 +368,10 @@ body:
346368
- [General Training](docs/sdk_developers/training)
347369
- [General SDK Developer Docs](docs/sdk_developers)
348370
349-
### Calls:
371+
#### Calls:
350372
- 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)
351373
- Learn, raise issues and provide feedback at [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meeting/92041330205?password=2f345bee-0c14-4dd5-9883-06fbc9c60581)
352374
353-
- type: textarea
354-
id: acceptance-criteria
355-
attributes:
356-
label: ✅ Acceptance criteria
357-
description: |
358-
Edit or expand this checklist with what is required to merge a pull request for this issue.
359-
value: |
360-
To be able to close this issue, the following criteria must be met:
361-
362-
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements.
363-
364-
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue.
365-
366-
- [ ] **Behavior:** All other existing features continue to work as before.
367-
368-
- [ ] **Checks and feedback:** All checks pass and any requested changes have been made.
369-
validations:
370-
required: true
371-
372375
- type: textarea
373376
id: ai_usage_guidelines
374377
attributes:

0 commit comments

Comments
 (0)