Skip to content

docs: Add EIP checklist templates #1327

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 33 commits into from
May 14, 2025
Merged

docs: Add EIP checklist templates #1327

merged 33 commits into from
May 14, 2025

Conversation

marioevz
Copy link
Member

@marioevz marioevz commented Mar 18, 2025 •
edited
Loading

πŸ—’οΈ Description

This PR aims to introduce EIP checklist templates that must be followed when implementing tests for a given EIP.

πŸ”— Related Issues

βœ… Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.
  • Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
  • Tests: A PR with removal of converted JSON/YML tests from ethereum/tests have been opened.
  • Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz mentioned this pull request Mar 20, 2025
Open
6 tasks
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
winsvega
winsvega reviewed Mar 24, 2025
View reviewed changes
jochem-brouwer
jochem-brouwer reviewed Mar 24, 2025
View reviewed changes
Copy link
Member

@jochem-brouwer jochem-brouwer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments, this is after a first pass of this checklist :) Will check again later and when I think of more "exotic" cases, will add them. I might have commented on some cases which are already added, but which I missed (sorry about that).

spencer-tb
spencer-tb reviewed Apr 1, 2025
View reviewed changes
Copy link
Contributor

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome so far! I will come back to this after you have pushed your changes. Some thoughts you might want to include.

@spencer-tb spencer-tb added scope:docs Scope: Documentation fork:prague Prague hardfork labels Apr 14, 2025
danceratopz
danceratopz reviewed Apr 16, 2025
View reviewed changes
danceratopz
danceratopz reviewed Apr 16, 2025
View reviewed changes
@spencer-tb
Copy link
Contributor

I think we should consider merging this and build upon it during fusaka. Added it to the final pectra release issue:
#1508

@marioevz - let me know what you think, once you mark the PR for as ready for review I'll re-review it all!

@spencer-tb spencer-tb mentioned this pull request May 9, 2025
Closed
14 tasks
@marioevz
Copy link
Member Author

marioevz commented May 9, 2025

I think we should consider merging this and build upon it during fusaka. Added it to the final pectra release issue: #1508

@marioevz - let me know what you think, once you mark the PR for as ready for review I'll re-review it all!

This is a great idea, I'm going to push to have this finished today and merged.

@marioevz marioevz marked this pull request as ready for review May 9, 2025 23:02
@marioevz
Copy link
Member Author

marioevz commented May 9, 2025

@danceratopz @spencer-tb I think this one is ready to merge. Let me know what you think.

@danceratopz danceratopz mentioned this pull request May 14, 2025
Merged
danceratopz
danceratopz reviewed May 14, 2025
View reviewed changes
Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EIP EL checklist is really an amazing document.

I def think we should publish this on eest.ethereum.org for ease of sharing (the tables format really well, too)!

Added that suggestion and fixed some formatting here:

danceratopz
danceratopz approved these changes May 14, 2025
View reviewed changes
Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an amazing document, thanks @marioevz, @jochem-brouwer, @winsvega, @spencer-tb! I think it's going to be extremely useful.

Looking forward to the plugin πŸ˜‰

I addressed a few formatting issues in #1601 and just pushed some small cosmetic changes. I have one remaining comment below. Otherwise, a preemptive approve from me :)

marioevz and others added 25 commits May 14, 2025 17:55
@marioevz
More test vectors
6d9747e
@marioevz
More review comments
db7e952
@marioevz
Add asymetrical stack tests
f7742b1
@marioevz
Add some IDs
6fb207f
@marioevz
Add serialization items
8b0fc04
@marioevz
Add more serialization items
fd8dc8c
@marioevz
Add gas refunds category
8cb1b4d
@marioevz
docs: Add post-mortems
2fef85c
@marioevz
fix(github): Add the post-mortem docs to the PR template
0eb4cb0
@marioevz
fix: Remove references to EOF
c01ffd3
@marioevz @danceratopz
@spencer-tb @jochem-brouwer
fix: Review comments
a9b5f23 
Co-authored-by: danceratopz <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
Co-authored-by: Jochem Brouwer <[email protected]>
@marioevz
Add gas tests
7b97a89
@marioevz
Simplify bullet points
7e72f52
@marioevz
fix(docs): tox
417da23
@marioevz
Add more ids
a2a9439
@marioevz
Add more ids
5384ae8
@marioevz
Add more ids
4f3753c
@marioevz
Add more ids
da5638e
@marioevz
fix: tox
736c73c
@marioevz
refactor(docs): Convert EIP checklist to table
56877b2
@marioevz
fixes
d0466b7
@danceratopz @marioevz
Eip checklist suggestions (#1601)
50aaa31 
* chore(docs): auto-format doc, in particular tables, with prettier

* chore(docs): remove periods from sub-titles

* chore(docs): fix indentation in unordered lists

* chore(docs): add missing md table headers

* refactor(docs): indent navigation ready for more deeply nested entries

* docs: add testing checklists to docs/writing; include in html

* docs: update whitelist

* docs: disable MD001 for eip testing checklist
@danceratopz @marioevz
chore(docs): more consistent display of opcodes; fix capitalization
8465cca
@marioevz
fix(docs): Add fuzzing snippet
82aef1d
@marioevz
docs: Changelog
9da1c93
@marioevz marioevz merged commit cc9a56a into main May 14, 2025
21 checks passed
@marioevz marioevz deleted the eip-checklist branch May 14, 2025 18:23
felix314159 pushed a commit to felix314159/execution-spec-tests that referenced this pull request May 16, 2025
@marioevz @danceratopz
@spencer-tb @jochem-brouwer @felix314159
feat(docs): Add EIP checklist templates, post-mortem page (ethereum#1327
81fa617 
)

* docs: Add first checklist templates

* changes: Precompiles

* changes: System contracts

* nit

* changes: Add (incomplete) transaction tests

* More changes

* Add more encoding tests

* More cases

* More test vectors

* More review comments

* Add asymetrical stack tests

* Add some IDs

* Add serialization items

* Add more serialization items

* Add gas refunds category

* docs: Add post-mortems

* fix(github): Add the post-mortem docs to the PR template

* fix: Remove references to EOF

* fix: Review comments

Co-authored-by: danceratopz <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
Co-authored-by: Jochem Brouwer <[email protected]>

* Add gas tests

* Simplify bullet points

* fix(docs): tox

* Add more ids

* Add more ids

* Add more ids

* Add more ids

* fix: tox

* refactor(docs): Convert EIP checklist to table

* fixes

* Eip checklist suggestions (ethereum#1601)

* chore(docs): auto-format doc, in particular tables, with prettier

* chore(docs): remove periods from sub-titles

* chore(docs): fix indentation in unordered lists

* chore(docs): add missing md table headers

* refactor(docs): indent navigation ready for more deeply nested entries

* docs: add testing checklists to docs/writing; include in html

* docs: update whitelist

* docs: disable MD001 for eip testing checklist

* chore(docs): more consistent display of opcodes; fix capitalization

* fix(docs): Add fuzzing snippet

* docs: Changelog

---------

Co-authored-by: danceratopz <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
Co-authored-by: Jochem Brouwer <[email protected]>
codeofcarson pushed a commit to codeofcarson/execution-spec-tests that referenced this pull request Jul 1, 2025
@marioevz @danceratopz
@spencer-tb @jochem-brouwer @Carsons-Eels
feat(docs): Add EIP checklist templates, post-mortem page (ethereum#1327
456cdda 
)

* docs: Add first checklist templates

* changes: Precompiles

* changes: System contracts

* nit

* changes: Add (incomplete) transaction tests

* More changes

* Add more encoding tests

* More cases

* More test vectors

* More review comments

* Add asymetrical stack tests

* Add some IDs

* Add serialization items

* Add more serialization items

* Add gas refunds category

* docs: Add post-mortems

* fix(github): Add the post-mortem docs to the PR template

* fix: Remove references to EOF

* fix: Review comments

Co-authored-by: danceratopz <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
Co-authored-by: Jochem Brouwer <[email protected]>

* Add gas tests

* Simplify bullet points

* fix(docs): tox

* Add more ids

* Add more ids

* Add more ids

* Add more ids

* fix: tox

* refactor(docs): Convert EIP checklist to table

* fixes

* Eip checklist suggestions (ethereum#1601)

* chore(docs): auto-format doc, in particular tables, with prettier

* chore(docs): remove periods from sub-titles

* chore(docs): fix indentation in unordered lists

* chore(docs): add missing md table headers

* refactor(docs): indent navigation ready for more deeply nested entries

* docs: add testing checklists to docs/writing; include in html

* docs: update whitelist

* docs: disable MD001 for eip testing checklist

* chore(docs): more consistent display of opcodes; fix capitalization

* fix(docs): Add fuzzing snippet

* docs: Changelog

---------

Co-authored-by: danceratopz <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
Co-authored-by: Jochem Brouwer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@winsvega winsvega winsvega left review comments

@jochem-brouwer jochem-brouwer jochem-brouwer left review comments

@spencer-tb spencer-tb spencer-tb left review comments

@danceratopz danceratopz danceratopz approved these changes

Assignees
No one assigned
Labels
fork:prague Prague hardfork scope:docs Scope: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@marioevz @spencer-tb @winsvega @jochem-brouwer @danceratopz