Skip to content

Commit d18e850

Browse files
committed
chore(templates): address maintainer feedback on docs and linting
Signed-off-by: Ajay Rajera <newajay.11r@gmail.com>
1 parent 78dd7c2 commit d18e850

13 files changed

+91
-1241
lines changed

.github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ body:
1212
Good First Issue Candidates are proposed tasks that are being evaluated for suitability as Good First Issues. They may require clarification or refinement before they are ready to be picked up by new contributors.
1313
1414
Read more:
15-
> [Contribution Workflow](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md)
16-
> [First Contribution Checklist](https://github.com/hiero-ledger/hiero-website/blob/main/docs/05-first-contribution-checklist.md)
15+
> [Contribution Workflow](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
16+
> [Contributor Setup](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-setup.md) (OS Guides: [Mac](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/Macbook_setup.md) | [Windows](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/windows_setup.md) | [Linux](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/linux_setup.md))
1717
---
1818
1919
- type: textarea
@@ -123,19 +123,21 @@ body:
123123
label: 📋 Step-by-Step Setup Procedure
124124
description: Provide a step-by-step setup guide for new contributors
125125
value: |
126-
- [ ] Visual Studio (VS) Code: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#visual-studio-code)
126+
- [ ] Visual Studio (VS) Code: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-setup.md)
127127
128-
- [ ] GitHub Desktop: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#github-desktop)
128+
- [ ] **OS-Specific Setup:** [Mac](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/Macbook_setup.md) | [Windows](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/windows_setup.md) | [Linux](https://github.com/hiero-ledger/hiero-website/blob/main/docs/setup/linux_setup.md)
129129
130-
- [ ] Create a GPG key linked to GitHub: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/signing.md#1-generate-a-gpg-key)
130+
- [ ] GitHub Desktop: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md#github-desktop)
131131
132-
- [ ] **Fork** Create an online and local copy of the repository: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#2-fork-the-repository)
132+
- [ ] Create a GPG key linked to GitHub: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/signing.md)
133133
134-
- [ ] **Connect** origin with upstream: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#2-fork-the-repository)
134+
- [ ] **Fork** Create an online and local copy of the repository: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
135+
136+
- [ ] **Connect** origin with upstream: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
135137
136138
- [ ] **Install dependencies:** run `pnpm install` in the project root
137139
138-
- [ ] **Sync Main** pull any recent upstream changes: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/rebasing.md#2-sync-your-main-on-your-fork)
140+
- [ ] **Sync Main** pull any recent upstream changes: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)
139141
140142
You are set up! 🎉
141143
@@ -147,33 +149,33 @@ body:
147149
value: |
148150
#### ✅ Get ready
149151
150-
- [ ] **Claim the issue:** comment `/assign`: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#3-get-assigned-to-an-issue). Pull requests created without being assigned will be automatically closed.
152+
- [ ] **Claim the issue:** comment `/assign`: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md). Pull requests created without being assigned will be automatically closed.
151153
152154
- [ ] **Double check the Issue and AI plan:** carefully re-read the issue description and any AI plan below
153155
154-
- [ ] **Ask questions early:** ask on [Discord](https://github.com/hiero-ledger/hiero-website/blob/main/docs/discord.md), and the `@good_first_issue_support_team` (setup and workflow help)
156+
- [ ] **Ask questions early:** ask on [Discord](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/discord.md), and the `@good_first_issue_support_team` (setup and workflow help)
155157
156-
- [ ] **Sync Main** pull any recent upstream changes: [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/rebasing.md#2-sync-your-main-on-your-fork)
158+
- [ ] **Sync Main** pull any recent upstream changes: [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)
157159
158160
- [ ] 💡 Tip: Before coding, you are free to leave a short comment describing what you plan to change. We'll confirm you're on the right track.
159161
160162
#### 🛠️ Solve the Issue
161163
162-
- [ ] **Create a branch from `main`:** [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#4-create-a-branch)
164+
- [ ] **Create a branch from `main`:** [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
163165
164166
- [ ] **Implement the solution**: follow the implementation steps in the issue description.
165167
166-
- [ ] **Commit with Conventional format and DCO, GPG signing:** commit changes using: `git commit -S -s -m "chore: your message"`, [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#5-commit-your-changes)
168+
- [ ] **Commit with Conventional format and DCO, GPG signing:** commit changes using: `git commit -S -s -m "chore: your message"`, [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
167169
168170
#### 🚀 Create the pull request
169171
170-
- [ ] **Push your commits:** push your branch to your fork `git push origin your-branch-name` [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#submitting-a-pull-request)
172+
- [ ] **Push your commits:** push your branch to your fork `git push origin your-branch-name` [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
171173
172-
- [ ] **Open a pull request:** [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#submitting-a-pull-request)
174+
- [ ] **Open a pull request:** [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
173175
174-
- [ ] **Complete the PR description:** briefly describe your changes, [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#submitting-a-pull-request)
176+
- [ ] **Complete the PR description:** briefly describe your changes, [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md)
175177
176-
- [ ] **Link the Issue:** link the issue the PR solves in the PR description, [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/workflow.md#submitting-a-pull-request). Pull requests created without a linked issue will be automatically closed.
178+
- [ ] **Link the Issue:** link the issue the PR solves in the PR description, [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/contributor-workflow.md). Pull requests created without a linked issue will be automatically closed.
177179
178180
- [ ] **Submit the pull request:** click `**Create pull request**` and `Ready to Review` 🎉
179181
@@ -190,9 +192,14 @@ body:
190192
191193
- [ ] I have worked from a branch that is up to date with main
192194
- [ ] I have not made changes outside the scope of this issue
193-
- [ ] My commits are signed: `git commit -S -s -m "chore: description"` — [Signing guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/signing.md)
195+
- [ ] My commits are signed: `git commit -S -s -m "chore: description"` — [Signing guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/signing.md)
194196
- [ ] I linked the issue in my PR description using `Fixes #issue_number` to automatically close it when merged
195-
- [ ] I have applied appropriate linting, code quality, and formatting tools used in this repo (if applicable).
197+
- [ ] I have run the following commands locally and **all pass** (CI will automatically fail your PR if any of these fail):
198+
- `pnpm format:check` — checks code formatting
199+
- `pnpm lint` — runs the linter (**the CI lint check will block your PR if this fails**)
200+
- `pnpm test` — runs the test suite
201+
- `pnpm build` — ensures the project builds successfully
202+
- [Testing guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/06-testing-and-quality-checks.md)
196203
197204
Issue Requirement:
198205
- [ ] The issue is solved: I've carefully read and implemented the issue requirements
@@ -219,7 +226,7 @@ body:
219226
Approved PRs are usually merged within **one day**.
220227
221228
**🔄 Merge conflicts (sometimes)**
222-
Conflicts can happen and are normal as the website updates. Resolve using this [Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/merge_conflicts.md)
229+
Conflicts can happen and are normal as the website updates. Resolve using this [Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md)
223230
224231
> [!TIP]
225232
> **Follow the workflow and double check your work**
@@ -241,9 +248,10 @@ body:
241248
242249
#### Other Resources:
243250
244-
- [Contributor Docs (Signing, Rebasing, Merge Conflicts, Workflow, Setup)](https://github.com/hiero-ledger/hiero-website/tree/main/docs)
245-
- [GitHub Automation Guide](https://github.com/hiero-ledger/hiero-website/blob/main/docs/07-github-automation.md)
251+
- [Contributor Docs (Signing, Rebasing, Merge Conflicts, Workflow, Setup)](https://github.com/hiero-ledger/sdk-collaboration-hub/tree/main/guides/issue-progression/for-developers)
252+
- [GitHub Automation Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/github-action-workflows.md)
253+
- [Website-Specific Docs (Repo Overview, Components, Testing)](https://github.com/hiero-ledger/hiero-website/tree/main/docs)
246254
- [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meetings/hiero?view=week)
247-
- [Discord](https://github.com/hiero-ledger/hiero-website/blob/main/docs/discord.md)
255+
- [Discord](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/discord.md)
248256
249257
---

0 commit comments

Comments
 (0)