Skip to content

Commit 3b293cd

Browse files
marioevzCarsons-Eelsspencer-tbfselmo
authored andcommitted
enhance(ci): Add EIP Tracker Issue Template (ethereum#1847)
* enhance(ci): Add EIP Tracker Issue Template * Add note and paraphrase. * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml Co-authored-by: Carson <carson@binarycake.ca> * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml Co-authored-by: spencer <spencer.tb@ethereum.org> * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml Co-authored-by: Carson <carson@binarycake.ca> * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml Co-authored-by: spencer <spencer.tb@ethereum.org> * Review feedback * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml * Apply suggestions from code review Co-authored-by: felipe <fselmo2@gmail.com> * Review comments * Update .github/ISSUE_TEMPLATE/eip-tracker.yaml --------- Co-authored-by: Carson <carson@binarycake.ca> Co-authored-by: spencer <spencer.tb@ethereum.org> Co-authored-by: felipe <fselmo2@gmail.com>
1 parent 3a85f3d commit 3b293cd

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: "EIP Implementation Tracker"
2+
description: "Track specification and testing progress for an EIP"
3+
title: "EIP ${{ form.eip_number }} Progress Tracker"
4+
labels:
5+
- A-spec-specs
6+
- A-spec-tests
7+
- C-eip
8+
- C-test
9+
10+
body:
11+
- type: input
12+
id: eip_number
13+
attributes:
14+
label: "EIP Number"
15+
description: "Enter the EIP number (digits only)."
16+
placeholder: "e.g., 8024"
17+
validations:
18+
required: true
19+
20+
- type: input
21+
id: eip_title
22+
attributes:
23+
label: "EIP Title"
24+
description: "Copy the title from the EIP."
25+
placeholder: "e.g., Backwards compatible SWAPN, DUPN, EXCHANGE"
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: fork
31+
attributes:
32+
label: "Fork"
33+
description: |
34+
Specify the target fork **only if the EIP has reached the CFI stage**.
35+
More info: https://eips.ethereum.org/EIPS/eip-7723#considered-for-inclusion
36+
options:
37+
- TBD
38+
- amsterdam
39+
- bogota
40+
validations:
41+
required: true
42+
43+
- type: markdown
44+
attributes:
45+
value: |
46+
## [EIP-${{ form.eip_number }}](https://eips.ethereum.org/EIPS/eip-${{ form.eip_number }})
47+
48+
### Target Fork
49+
50+
Fork **${{ form.fork }}**
51+
52+
### Instructions
53+
54+
- [ ] Assign issue to EIP specification and testing owner(s).
55+
56+
> [!IMPORTANT]
57+
> A specifications specialist and a testing specialist should ideally share ownership of the EIP.
58+
59+
- [ ] Add the issue to the target fork milestone if applicable (i.e., the EIP is at least in the [CFI stage](https://eips.ethereum.org/EIPS/eip-7723#considered-for-inclusion)).
60+
61+
#### Guidance for Marking Items Complete
62+
63+
An item should only be checked off once the EIP is considered *stable*. In this context, stable means:
64+
65+
- No major issues or ambiguities are still being uncovered in the specification or tests.
66+
- There are no open discussion points awaiting resolution.
67+
- Client implementations have been consistently passing the tests for at least a week.
68+
69+
It is ultimately up to the owners' discretion to decide when an item should be marked as complete, using this guidance as the basis for that decision.
70+
71+
In exceptional cases, an EIP may require changes after some items have been marked complete or even after the entire issue has been completed and closed. This can happen, for example, when significant design optimizations are identified and agreed upon in ACD, or when critical security issues surface and require updates to the specification or tests.
72+
73+
When this occurs, owners should either unmark the relevant checkboxes if the issue is still open, or create a new tracking issue for the modifications if the original issue had already been closed.
74+
75+
### Specification + Testing Status
76+
77+
- [ ] Testing complexity assessed and documented.
78+
- [ ] Specification implementation merged to `eips/${{ form.fork }}/eip-${{ form.eip_number }}` *(skip if the fork branch merge below is already complete)*.
79+
- [ ] Specification updates merged to the corresponding `forks/${{ form.fork }}` branch.
80+
- [ ] EIP updates proposed in case of architectural choices surfaced during implementation.
81+
- [ ] Required testing framework modifications implemented.
82+
- [ ] Test suite implemented.
83+
- [ ] Full code coverage for all changes.
84+
- [ ] No regressions or failures in tests from prior forks (including static tests).
85+
- [ ] [Testing checklist](https://github.com/ethereum/execution-specs/blob/HEAD/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md) complete.
86+
- [ ] Hardening session completed.
87+
- [ ] Benchmarking tests written and results documented.
88+
- [ ] Ran tests using `execute` to ensure compatibility, and marked specific tests to be skipped when they cannot be executed on live networks.
89+
- [ ] Added Mainnet-marked tests ([example test](https://github.com/ethereum/execution-specs/blob/2a6f9ee98ba7c0d04c7d523a0ea0ee8a98a5c418/tests/osaka/eip7939_count_leading_zeros/test_eip_mainnet.py)).
90+
91+
### Process Status
92+
93+
- [ ] Hive tests passing on at least two implementations.
94+
- [ ] EIP included in a devnet.

0 commit comments

Comments
 (0)