-
Notifications
You must be signed in to change notification settings - Fork 392
enhance(ci): Add EIP Tracker Issue Template #1847
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: forks/osaka
Are you sure you want to change the base?
Changes from all commits
4852cfe
75b7ae0
abf6055
691545c
000279d
1d0d104
7d28961
c19ad02
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,81 @@ | ||||||||||||||||||||||||
| name: "EIP Implementation Tracker" | ||||||||||||||||||||||||
| description: "Track specification and testing progress for an EIP" | ||||||||||||||||||||||||
| title: "EIP ${{ form.eip_number }} Progress Tracker" | ||||||||||||||||||||||||
| labels: | ||||||||||||||||||||||||
| - A-spec-specs | ||||||||||||||||||||||||
| - A-spec-tests | ||||||||||||||||||||||||
| - C-eip | ||||||||||||||||||||||||
| - C-test | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| body: | ||||||||||||||||||||||||
| - type: input | ||||||||||||||||||||||||
| id: eip_number | ||||||||||||||||||||||||
| attributes: | ||||||||||||||||||||||||
| label: "EIP Number" | ||||||||||||||||||||||||
| description: "Enter the EIP number (digits only)." | ||||||||||||||||||||||||
| placeholder: "e.g., 8024" | ||||||||||||||||||||||||
| validations: | ||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - type: input | ||||||||||||||||||||||||
| id: eip_title | ||||||||||||||||||||||||
| attributes: | ||||||||||||||||||||||||
| label: "EIP Title" | ||||||||||||||||||||||||
| description: "Copy the title from the EIP." | ||||||||||||||||||||||||
| placeholder: "e.g., Backwards compatible SWAPN, DUPN, EXCHANGE" | ||||||||||||||||||||||||
| validations: | ||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - type: dropdown | ||||||||||||||||||||||||
| id: fork | ||||||||||||||||||||||||
| attributes: | ||||||||||||||||||||||||
| label: "Fork" | ||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||
| Specify the target fork **only if the EIP has reached the CFI stage**. | ||||||||||||||||||||||||
| More info: https://eips.ethereum.org/EIPS/eip-7723#considered-for-inclusion | ||||||||||||||||||||||||
| options: | ||||||||||||||||||||||||
| - TBD | ||||||||||||||||||||||||
| - amsterdam | ||||||||||||||||||||||||
| - bogota | ||||||||||||||||||||||||
| validations: | ||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - type: markdown | ||||||||||||||||||||||||
| attributes: | ||||||||||||||||||||||||
| value: | | ||||||||||||||||||||||||
| ## [EIP-${{ form.eip_number }}](https://eips.ethereum.org/EIPS/eip-${{ form.eip_number }}) | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### Target Fork | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Fork **${{ form.fork }}** | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### Instructions | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - [ ] Assign issue to EIP specification and testing owner(s). | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| > [!IMPORTANT] | ||||||||||||||||||||||||
| > A specifications specialist and a testing specialist should ideally share ownership of the EIP. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - [ ] 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]). | ||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. broken link styling I think
Suggested change
|
||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### Specification + Testing Status | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - [ ] Testing complexity assessed and documented. | ||||||||||||||||||||||||
| - [ ] Specification implementation merged to `eips/${{ form.fork }}/eip-${{ form.eip_number }}` *(skip if the fork branch merge below is already complete)*. | ||||||||||||||||||||||||
| - [ ] Specification updates merged to the corresponding `forks/${{ form.fork }}` branch. | ||||||||||||||||||||||||
| - [ ] EIP updates proposed in case of architectural choices surfaced during implementation. | ||||||||||||||||||||||||
| - [ ] Required testing framework modifications implemented. | ||||||||||||||||||||||||
| - [ ] Test suite implemented. | ||||||||||||||||||||||||
| - [ ] Full code coverage for all changes. | ||||||||||||||||||||||||
| - [ ] [Testing checklist](https://github.com/ethereum/execution-specs/blob/HEAD/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md) complete. | ||||||||||||||||||||||||
| - [ ] No regressions or failures in tests from prior forks (including static tests). | ||||||||||||||||||||||||
| - [ ] Hardening session completed. | ||||||||||||||||||||||||
| - [ ] Benchmarking performed and results documented. | ||||||||||||||||||||||||
marioevz marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||
| - [ ] Ran tests using `execute` to ensure compatibility, and marked specific tests to be skipped when they cannot be executed on live networks. | ||||||||||||||||||||||||
| - [ ] Added Mainnet-marked tests ([example test](https://github.com/ethereum/execution-specs/blob/2a6f9ee98ba7c0d04c7d523a0ea0ee8a98a5c418/tests/osaka/eip7939_count_leading_zeros/test_eip_mainnet.py)). | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### Process Status | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| - [ ] Hive tests passing on all implementations. | ||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It might be nice to make this more granular.
Suggested change
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like this is too much, we could instead create another template. But even this single bullet-point I'm not completely convinced we should put it in here because it's such a fluctuating state. E.g. we could introduce new tests that break implementations, or a client might have a regression. Do either of those mean we have to come back here and uncheck this checkbox?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. After thinking about it, I feel we can make this point a bit more flexible:
Two implementations feels to me like the right balance to mark this as complete. And reasoning is:
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm good with "at least two" I think. Are we talking about a full implementation here where we believe the specs are now correct, we have enough tests for coverage, and there are at least two clients passing all of the tests? Or is this still within the development cycle? It will be the case where specs are implemented, some clients implement it as well, and you start going back and forth on a consensus of what is implemented correctly and what is not. Then you tweak the specs and tests, tweak the client implementations, etc... so...
Also, if we go with this approach, we should have a section that tracks which clients have implemented it so we can signal this and ideally we should link to the branch in the relevant repos. |
||||||||||||||||||||||||
| - [ ] EIP included in a devnet. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.