Skip to content

Commit 5b57ef3

Browse files
authored
docs: refine Advanced Issue Template UX and prerequisites (#2037)
Signed-off-by: Akshat Kumar <akshat230405@gmail.com>
1 parent f0028f7 commit 5b57ef3

2 files changed

Lines changed: 12 additions & 15 deletions

File tree

.github/ISSUE_TEMPLATE/05_advanced_issue.yml

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
attributes:
1111
label: 🧠 Advanced Contributors — Prerequisites & Expectations
1212
description: |
13-
PRE-FILLED. DO NOT CLAIM THIS ISSUE UNLESS YOU MEET THESE GUIDELINES.
13+
REQUIRED: Contributors must meet these thresholds before claiming.
1414
value: |
1515
> [!CAUTION]
1616
> **Advanced issues are the highest-risk work in this project. We will reject PRs that do not meet these standards.**
@@ -19,6 +19,7 @@ body:
1919
- **Proven History:** Successfully completed **≥ 10 non-trivial intermediate issues** in this repo.
2020
- **Consistency:** **≥ 3–4 months** of active, human-led contributions to this SDK.
2121
- **Expertise:** Deep architectural understanding of `_Executable`, `Transaction`, and `Query` base classes.
22+
- **Advanced Python:** Demonstrated proficiency with complex patterns (e.g., async concurrency, decorators, or state management) used in the core SDK.
2223
2324
> [!NOTE]
2425
> **Workflow Exception:** For issues focused on **GitHub Actions / Workflows**, the Python-specific thresholds above may be waived if the contributor demonstrates expert-level proficiency in CI/CD security and automation.
@@ -72,23 +73,19 @@ body:
7273
validations:
7374
required: false
7475

75-
- type: checkboxes
76+
- type: textarea
7677
id: acceptance
7778
attributes:
7879
label: ✅ PR Quality Checklist
7980
description: |
80-
The contributor must manually verify each of these criteria in their Pull Request.
81-
options:
82-
- label: "I understand the system-wide impact of these changes on affected modules and performance."
83-
required: true
84-
- label: "The system design fits with current Hiero SDK architectural approaches."
85-
required: true
86-
- label: "I have tested my changes extensively against both local and network environments."
87-
required: true
88-
- label: "I have verified naming, types, and field ordering against pinned Protobufs (v0.72.0-rc.2)."
89-
required: true
90-
- label: "Every line of code is personally understood and explainable (no unvalidated AI code)."
91-
required: true
81+
PRE-FILLED. These are the standards the contributor must meet before opening a PR.
82+
value: |
83+
Before opening your PR, the contributor must confirm:
84+
- [ ] I understand the system-wide impact of these changes on affected modules and performance.
85+
- [ ] The system design fits with current Hiero SDK architectural approaches.
86+
- [ ] I have tested my changes extensively against both local and network environments.
87+
- [ ] I have verified naming, types, and field ordering against pinned Protobufs (v0.72.0-rc.2).
88+
- [ ] Every line of code is personally understood and explainable (no unvalidated AI code).
9289
9390
- type: textarea
9491
id: resources

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
2020

2121
### .github
2222
- Refactored the Advanced Issue Template to V2 with stricter prerequisites and a focus on architectural design (#2016).
23-
23+
- Refactored the Advanced Issue Template to ensure PR-level quality checklists do not block maintainers during issue creation (#2036)
2424
## [0.2.3] - 2026-03-26
2525

2626
### Added

0 commit comments

Comments
 (0)