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
PRE-FILLED. DO NOT CLAIM THIS ISSUE UNLESS YOU MEET THESE GUIDELINES.
10
14
value: |
11
-
---
12
-
## **Thanks for contributing!** 🚀
13
-
14
-
We truly appreciate your interest in tackling an **Advanced issue**.
15
-
16
-
This template is designed for work that requires **deep familiarity with the Hiero Python SDK**
17
-
and confidence making changes that may span multiple modules or affect core behavior.
15
+
> [!CAUTION]
16
+
> **Advanced issues are the highest-risk work in this project. We will reject PRs that do not meet these standards.**
18
17
19
-
The goal is to create issues for contributors who:
20
-
- have strong familiarity with the Hiero Python SDK internals
21
-
- are comfortable reasoning about trade-offs and design decisions
22
-
- can work independently with minimal guidance
23
-
---
18
+
### 🏁 Concrete Prerequisites
19
+
- **Proven History:** Successfully completed **≥ 10 non-trivial intermediate issues** in this repo.
20
+
- **Consistency:** **≥ 3–4 months** of active, human-led contributions to this SDK.
21
+
- **Expertise:** Deep architectural understanding of `_Executable`, `Transaction`, and `Query` base classes.
24
22
25
-
- type: textarea
26
-
id: intro
27
-
attributes:
28
-
label: 🧠 Advanced Contributors
29
-
description: Who is this issue intended for?
30
-
value: |
31
-
This issue is intended for contributors who are already very familiar with the
32
-
[Hiero Python SDK](https://hiero.org) codebase and its architectural patterns.
23
+
> [!NOTE]
24
+
> **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.
33
25
34
-
You should feel comfortable:
35
-
- navigating multiple modules across `src/`
36
-
- understanding and modifying core SDK abstractions
37
-
- reasoning about API design and backwards compatibility
38
-
- updating or extending tests, examples, and documentation as needed
39
-
- making changes that may affect public-facing behavior
26
+
### ⚠️ AI Usage Policy
27
+
Using AI to generate code for Advanced issues is **strictly forbidden**. AI may be used only to help explain file relationships. Submitting AI-mined code or unvalidated generated output is grounds for **immediate rejection**.
40
28
41
-
New developers should start with
42
-
**Good First Issues** or **Intermediate Issues** first.
29
+
### ⏱️ Timeline & Workflow
30
+
- **Typical time:** ~1 month / ~50 hours.
31
+
- 🔴 Completing an advanced issue in 1–3 days is a **red flag** and will likely be rejected.
32
+
- **Mandatory:** Post your proposed architectural approach as a comment and wait for explicit maintainer approval **before writing any code.**
43
33
validations:
44
34
required: false
45
35
46
-
- type: markdown
47
-
attributes:
48
-
value: |
49
-
> [!WARNING]
50
-
> ### 🧭 What we consider an *Advanced Issue*
51
-
>
52
-
> This issue typically:
53
-
>
54
-
> - Requires **deep understanding of existing SDK design and behavior**
55
-
> - May touch **core abstractions**, shared utilities, or cross-cutting concerns
56
-
> - May involve **non-trivial refactors**, design changes, or behavior extensions
57
-
> - Has **medium to high risk** if implemented incorrectly
58
-
> - Requires careful consideration of **backwards compatibility**
59
-
> - May require updating **tests, examples, and documentation together**
60
-
>
61
-
> **What this issue is NOT:**
62
-
> - A simple bug fix
63
-
> - A narrowly scoped refactor
64
-
> - A task solvable by following existing patterns alone
- [ ] Follow existing architectural and coding conventions
205
-
- [ ] Include comprehensive tests covering new and existing behavior
206
-
- [ ] Update relevant examples and documentation
207
-
- [ ] Pass all CI checks
208
-
- [ ] Include a valid changelog entry
209
-
- [ ] be a DCO and GPG key signed as `git commit -S -s -m "chore: my change"` with a GPG key set up
67
+
### 🚀 Defining "Production Ready"
68
+
1. **Architectural Fit:** The solution must fit naturally into the existing SDK abstractions. Avoid "hacks" or isolated logic that bypasses the core execution model.
69
+
2. **Security & Correctness:** Evaluate all logic for injection risks, state corruption, or thread-safety issues. Every line of code must be manually verified.
70
+
3. **Maintainability:** Code must be clear enough for any other maintainer to debug without your assistance. Prefer standard patterns over "clever" one-liners.
71
+
4. **Backward Compatibility:** Public API signatures must be preserved. If a breaking change is required, it must be explicitly managed through a deprecation cycle.
210
72
validations:
211
-
required: true
73
+
required: false
212
74
213
-
- type: textarea
214
-
id: additional-info
75
+
- type: checkboxes
76
+
id: acceptance
215
77
attributes:
216
-
label: 📚 Additional Context, Links, or Prior Art
78
+
label: ✅ PR Quality Checklist
217
79
description: |
218
-
Add any references that may help:
219
-
- design docs
220
-
- prior discussions
221
-
- related issues or PRs
222
-
- external references
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)."
0 commit comments