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
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/02_good_first_issue.yml
+58-55Lines changed: 58 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ body:
33
33
attributes:
34
34
value: |
35
35
> [!IMPORTANT]
36
-
> ### 📋 Good First Issue (GFI) Guidelines
36
+
> #### 📋 Good First Issue (GFI) Guidelines
37
37
> 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.
38
38
>
39
39
> **Often a good fit for Good First Issues:**
@@ -177,7 +177,7 @@ body:
177
177
attributes:
178
178
value: |
179
179
<!-- Example implementation (hidden in submission) -->
180
-
### 👩💻 Implementation - Example
180
+
#### 👩💻 Implementation - Example
181
181
182
182
To break down the monolithic main function, you need to:
183
183
- [ ] Extract the Key Steps (set up a client, create a test account, create a token, associate the token)
@@ -215,23 +215,23 @@ body:
215
215
label: 📋 Step-by-Step Setup Guide
216
216
description: Provide a step-by-step setup guide for new contributors
217
217
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)
description: Provide a contribution workflow suitable for new contributors.
245
245
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)
248
248
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
250
250
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)
252
252
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)
254
254
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)
257
257
258
-
- [ ] **Implement the solution**: Follow the implementation steps in the issue description.
258
+
- [ ] **Implement the solution**: follow the implementation steps in the issue description.
259
259
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)
261
261
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)
263
263
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`
266
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).
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)
268
268
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)
- 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)
351
373
- Learn, raise issues and provide feedback at [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meeting/92041330205?password=2f345bee-0c14-4dd5-9883-06fbc9c60581)
352
374
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.
0 commit comments