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.

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

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

πŸ—’οΈ 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.

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).

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
@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!

@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.

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:

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 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
)

* 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
)

* 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
Labels
fork:prague Prague hardfork scope:docs Scope: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants