Skip to content

Commit 3ab5bde

Browse files
committed
chore: some tidy
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
1 parent d501a7c commit 3ab5bde

1 file changed

Lines changed: 68 additions & 42 deletions

File tree

.github/ISSUE_TEMPLATE/02_good_first_issue.yml

Lines changed: 68 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -210,28 +210,25 @@ body:
210210
label: 📋 Step-by-Step Setup Guide
211211
description: Provide a step-by-step setup guide for new contributors
212212
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)
213+
### Suggestions:
214+
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
215+
216+
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md).
217+
218+
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md).
219+
220+
- [ ] Create a GPG key linked to GitHub [Guide](docs/sdk_developers/signing.md).
223221
224222
### 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.
223+
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md).
224+
225+
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md).
226+
227+
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md).
228+
229+
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md).
230+
231+
You are set up! 🎉
235232
validations:
236233
required: true
237234

@@ -241,34 +238,32 @@ body:
241238
label: 📋 Step-by-step contribution guide
242239
description: Provide a contribution workflow suitable for new contributors.
243240
value: |
244-
Please follow these steps to contribute:
245-
246241
### ✅ Get ready
247-
- [ ] **Claim the issue:** Comment `/assign` [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md)
242+
- [ ] **Claim the issue:** Comment `/assign` [Guide](docs/sdk_developers/training/workflow/04_assigning_issues.md).
248243
249244
- [ ] **Double check the Issue and AI plan:**. Carefully re-read the issue description and the CodeRabbit AI plan.
250245
251-
- [ ] **Ask questions early:**. Ask on [Discord](docs/discord.md), your mentor (Python SDK help) or the `@good_first_issue_support_team` (setup help)
246+
- [ ] **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).
252247
253-
- [ ] **Sync with main:**. Pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md)
248+
- [ ] **Sync with main:** Pull the latest upstream changes [Guide](docs/sdk_developers/rebasing.md).
254249
255250
### 🛠️ Solve the Issue
256-
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md)
251+
- [ ] **Create a branch from `main`:** [Guide](docs/sdk_developers/training/workflow/05_working_branches.md).
257252
258-
- [ ] **Implement the solution**
253+
- [ ] **Implement the solution**: Follow the implementation steps in the issue description.
259254
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)
255+
- [ ] **Commit with DCO and GPG signing:** Commit changes using: `git commit -S -s -m "chore: your message"` [Guide](docs/sdk_developers/signing.md).
261256
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)
257+
- [ ] **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).
263258
264259
### 🚀 Create the pull request
265260
- [ ] **Push your commits:** Push your branch to your fork `git push origin your-branch-name`.
266261
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)
262+
- [ ] **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).
268263
269264
- [ ] **Complete the PR description:** Briefly describe your changes and link the issue [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md).
270265
271-
- [ ] **Submit the pull request:** Click **Create pull request** 🎉
266+
- [ ] **Submit the pull request:** Click `**Create pull request**` 🎉.
272267
273268
validations:
274269
required: true
@@ -279,18 +274,42 @@ body:
279274
label: 🤔 What to expect after submitting a PR
280275
description: Explain what happens after a pull request is opened.
281276
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.
277+
Once you open a pull request, here’s what happens next:
283278
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.
279+
### 🤖 Automated checks
280+
A few automated checks will run and **all must pass** before your PR can be merged, such as:
281+
- signing
282+
- changelog entry
283+
- solo unit and integration tests
284+
- examples
285+
- code quality checks
285286
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.
287+
👉 You can open each check to see detailed results and error messages if anything fails.
287288
288-
After approval, PRs are typically merged within a day.
289+
### 🤝 AI feedback (CodeRabbit)
290+
You’ll receive quick feedback from **CodeRabbit AI**, which may:
291+
- point out potential issues
292+
- suggest improvements or alternatives
289293
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)
294+
AI feedback is **advisory** — it can make mistakes - use what’s helpful and feel free to ask questions.
295+
296+
### 👀 Maintainer review
297+
A Python SDK team member will review your PR, typically within **1–3 days**.
298+
- You may be asked to make changes, or
299+
- Your PR may be approved as-is ✅
300+
301+
### 🚀 Merge
302+
Once approved, PRs are usually merged within **one day**.
303+
304+
### 🔄 Merge conflicts
305+
Merge conflicts can occasionally happen as the SDK updates. This is normal and fixable.
306+
307+
- **Changelog conflicts**
308+
These are common and can usually be resolved directly using GitHub’s online editor in the pull request.
309+
310+
- **Other conflicts**
311+
More complex conflicts may require rebasing your branch and resolving them locally.
312+
👉 Follow the step-by-step **[Rebasing Guide](docs/sdk_developers/rebasing.md)** for help.
294313
validations:
295314
required: true
296315

@@ -333,6 +352,8 @@ body:
333352
description: |
334353
Edit or expand this checklist with what is required to merge a pull request for this issue.
335354
value: |
355+
To be able to close this issue, the following criteria must be met:
356+
336357
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements.
337358
338359
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue.
@@ -349,7 +370,12 @@ body:
349370
label: 🤖 AI usage guidelines
350371
description: Guidance on using AI tools responsibly for this issue.
351372
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.
373+
You’re welcome to use AI tools while working on this issue.
374+
375+
**Use AI responsibly:**
376+
- Verify suggestions before applying them, such as by looking at similar examples
377+
- Work one small change at a time
378+
- Create small tests/checks as you go
354379
355-
If anything’s unclear, a mentor or maintainer is happy to help.
380+
**For Hiero Python SDK expert guidance:**
381+
- Ask a mentor/maintainer, they are happy to guide you on our best practices

0 commit comments

Comments
 (0)