You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Provide a contribution workflow suitable for new contributors.
243
240
value: |
244
-
Please follow these steps to contribute:
245
-
246
241
### ✅ 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).
248
243
249
244
- [ ] **Double check the Issue and AI plan:**. Carefully re-read the issue description and the CodeRabbit AI plan.
250
245
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).
252
247
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).
254
249
255
250
### 🛠️ 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).
257
252
258
-
- [ ] **Implement the solution**
253
+
- [ ] **Implement the solution**: Follow the implementation steps in the issue description.
259
254
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).
261
256
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).
263
258
264
259
### 🚀 Create the pull request
265
260
- [ ] **Push your commits:** Push your branch to your fork `git push origin your-branch-name`.
266
261
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).
268
263
269
264
- [ ] **Complete the PR description:** Briefly describe your changes and link the issue [Guide](docs/sdk_developers/training/workflow/11_submit_pull_request.md).
description: Explain what happens after a pull request is opened.
281
276
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:
283
278
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
285
286
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.
287
288
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
289
293
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.
294
313
validations:
295
314
required: true
296
315
@@ -333,6 +352,8 @@ body:
333
352
description: |
334
353
Edit or expand this checklist with what is required to merge a pull request for this issue.
335
354
value: |
355
+
To be able to close this issue, the following criteria must be met:
356
+
336
357
- [ ] **The issue is solved:** I’ve carefully read and implemented the issue requirements.
337
358
338
359
- [ ] **I did not add extra changes:** I did not modify anything beyond what is described in the issue.
@@ -349,7 +370,12 @@ body:
349
370
label: 🤖 AI usage guidelines
350
371
description: Guidance on using AI tools responsibly for this issue.
351
372
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
354
379
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