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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2ed8e18
docs: Add first checklist templates
marioevz Mar 18, 2025
cf08fea
changes: Precompiles
marioevz Mar 18, 2025
1558fa5
changes: System contracts
marioevz Mar 18, 2025
391f89f
nit
marioevz Mar 18, 2025
7a3a23d
changes: Add (incomplete) transaction tests
marioevz Mar 18, 2025
46689ba
More changes
marioevz Mar 21, 2025
039ccc5
Add more encoding tests
marioevz Mar 24, 2025
59bccaf
More cases
marioevz Mar 31, 2025
6d9747e
More test vectors
marioevz Mar 31, 2025
db7e952
More review comments
marioevz Mar 31, 2025
f7742b1
Add asymetrical stack tests
marioevz Apr 1, 2025
6fb207f
Add some IDs
marioevz Apr 1, 2025
8b0fc04
Add serialization items
marioevz Apr 1, 2025
fd8dc8c
Add more serialization items
marioevz Apr 1, 2025
8cb1b4d
Add gas refunds category
marioevz Apr 2, 2025
2fef85c
docs: Add post-mortems
marioevz Apr 11, 2025
0eb4cb0
fix(github): Add the post-mortem docs to the PR template
marioevz Apr 11, 2025
c01ffd3
fix: Remove references to EOF
marioevz May 9, 2025
a9b5f23
fix: Review comments
marioevz May 9, 2025
7b97a89
Add gas tests
marioevz May 9, 2025
7e72f52
Simplify bullet points
marioevz May 9, 2025
417da23
fix(docs): tox
marioevz May 9, 2025
a2a9439
Add more ids
marioevz May 9, 2025
5384ae8
Add more ids
marioevz May 9, 2025
4f3753c
Add more ids
marioevz May 9, 2025
da5638e
Add more ids
marioevz May 9, 2025
736c73c
fix: tox
marioevz May 9, 2025
56877b2
refactor(docs): Convert EIP checklist to table
marioevz May 13, 2025
d0466b7
fixes
marioevz May 13, 2025
50aaa31
Eip checklist suggestions (#1601)
danceratopz May 14, 2025
8465cca
chore(docs): more consistent display of opcodes; fix capitalization
danceratopz May 14, 2025
82aef1d
fix(docs): Add fuzzing snippet
marioevz May 14, 2025
9da1c93
docs: Changelog
marioevz May 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
- [ ] Tests: A PR with removal of converted JSON/YML tests from [ethereum/tests](/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](https://eest.ethereum.org/main/tests/) are correctly formatted.
- [ ] Tests: For PRs implementing a missed test case, update the [post-mortem document](/ethereum/execution-spec-tests/blob/main/docs/writing_tests/post_mortems.md) to add an entry the list.
3 changes: 3 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ Test fixtures for use by clients are available for each release on the [Github r

### πŸ“‹ Misc

- ✨ Added the [EIP checklist template](https://eest.ethereum.org/main/writing_tests/checklist_templates/eip_testing_checklist_template/) that serves as a reference to achieve better coverage when implementing tests for new EIPs ([#1327](https://github.com/ethereum/execution-spec-tests/pull/1327)).
- ✨ Added [Post-Mortems of Missed Test Scenarios](https://eest.ethereum.org/main/writing_tests/post_mortems/) to the documentation that serves as a reference list of all cases that were missed during the test implementation phase of a new EIP, and includes the steps taken in order to prevent similar test cases to be missed in the future ([#1327](https://github.com/ethereum/execution-spec-tests/pull/1327)).

### πŸ§ͺ Test Cases

## [v4.5.0](https://github.com/ethereum/execution-spec-tests/releases/tag/v4.5.0) - 2025-05-14
Expand Down
97 changes: 50 additions & 47 deletions docs/navigation.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,60 @@
<!-- markdownlint-disable MD007 MD041 (MD007=ul-indent MD041=first-line-heading) -->
* [Home](index.md)
* Getting Started
* [Installation](getting_started/installation.md)
* [Installation Troubleshooting](getting_started/installation_troubleshooting.md)
* [VS Code Setup](getting_started/setup_vs_code.md)
* [Repository Overview](getting_started/repository_overview.md)
* [Getting Help](getting_started/getting_help.md)
* [Installation](getting_started/installation.md)
* [Installation Troubleshooting](getting_started/installation_troubleshooting.md)
* [VS Code Setup](getting_started/setup_vs_code.md)
* [Repository Overview](getting_started/repository_overview.md)
* [Getting Help](getting_started/getting_help.md)
* [Writing Tests](writing_tests/index.md)
* [Adding a New Test](writing_tests/adding_a_new_test.md)
* [Types of Test](writing_tests/types_of_tests.md)
* [Writing a New Test](writing_tests/writing_a_new_test.md)
* [Test Markers](writing_tests/test_markers.md)
* [Referencing an EIP Spec Version](writing_tests/reference_specification.md)
* [Verifying Changes Locally](writing_tests/verifying_changes.md)
* [Code Standards](writing_tests/code_standards.md)
* [Exception Tests](writing_tests/exception_tests.md)
* [Tutorial: Adding a State Test](writing_tests/tutorials/state_transition.md)
* [Adding a New Test](writing_tests/adding_a_new_test.md)
* [Types of Test](writing_tests/types_of_tests.md)
* [Writing a New Test](writing_tests/writing_a_new_test.md)
* [Test Markers](writing_tests/test_markers.md)
* [Verifying Changes Locally](writing_tests/verifying_changes.md)
* [Code Standards](writing_tests/code_standards.md)
* [Exception Tests](writing_tests/exception_tests.md)
* [Referencing an EIP Spec Version](writing_tests/reference_specification.md)
* [Testing Checklist Templates](writing_tests/checklist_templates/index.md)
* [EIP Execution Layer Testing Checklist Template](writing_tests/checklist_templates/eip_testing_checklist_template.md)
* [Post-mortems](writing_tests/post_mortems.md)
* [Tutorial: Adding a State Test](writing_tests/tutorials/state_transition.md)
* [Filling Tests](filling_tests/index.md)
* [Getting Started](filling_tests/getting_started.md)
* [Filling Tests at a Prompt](filling_tests/filling_tests_command_line.md)
* [Filling Tests in VS Code](filling_tests/filling_tests_vs_code.md)
* [Filling Tests for Features Under Development](filling_tests/filling_tests_dev_fork.md)
* [Transition Tool Support](filling_tests/transition_tool_support.md)
* [Debugging Transition Tools](filling_tests/debugging_t8n_tools.md)
* [Getting Started](filling_tests/getting_started.md)
* [Filling Tests at a Prompt](filling_tests/filling_tests_command_line.md)
* [Filling Tests in VS Code](filling_tests/filling_tests_vs_code.md)
* [Filling Tests for Features Under Development](filling_tests/filling_tests_dev_fork.md)
* [Transition Tool Support](filling_tests/transition_tool_support.md)
* [Debugging Transition Tools](filling_tests/debugging_t8n_tools.md)
* [Consuming Tests](consuming_tests/index.md)
* [State Tests](consuming_tests/state_test.md)
* [Blockchain Tests](consuming_tests/blockchain_test.md)
* [Blockchain Engine Tests](consuming_tests/blockchain_test_engine.md)
* [EOF Tests](consuming_tests/eof_test.md)
* [Transaction Tests](consuming_tests/transaction_test.md)
* [Common Types](consuming_tests/common_types.md)
* [Exceptions](consuming_tests/exceptions.md)
* [State Tests](consuming_tests/state_test.md)
* [Blockchain Tests](consuming_tests/blockchain_test.md)
* [Blockchain Engine Tests](consuming_tests/blockchain_test_engine.md)
* [EOF Tests](consuming_tests/eof_test.md)
* [Transaction Tests](consuming_tests/transaction_test.md)
* [Common Types](consuming_tests/common_types.md)
* [Exceptions](consuming_tests/exceptions.md)
* [Executing Tests](executing_tests/index.md)
* [Developer Doc](dev/index.md)
* [Managing Configurations](dev/configurations.md)
* [Interactive Library Usage](dev/interactive_usage.md)
* [Generating Documentation](dev/docs.md)
* [Documenting CLI Commands](dev/documenting_clis.md)
* [Coding Style](dev/coding_style.md)
* [Logging](dev/logging.md)
* [Enabling Precommit Checks](dev/precommit.md)
* [Running Github Actions Locally](dev/test_actions_locally.md)
* [Porting Legacy Tests](dev/porting_legacy_tests.md)
* [Managing Configurations](dev/configurations.md)
* [Interactive Library Usage](dev/interactive_usage.md)
* [Generating Documentation](dev/docs.md)
* [Documenting CLI Commands](dev/documenting_clis.md)
* [Coding Style](dev/coding_style.md)
* [Logging](dev/logging.md)
* [Enabling Precommit Checks](dev/precommit.md)
* [Running Github Actions Locally](dev/test_actions_locally.md)
* [Porting Legacy Tests](dev/porting_legacy_tests.md)
* [Changelog](CHANGELOG.md)
* [Library Reference](library/index.md)
* [EEST CLI Tools](library/cli/index.md)
* [Ethereum Test Base Types Package](library/ethereum_test_base_types.md)
* [Ethereum Test Exceptions Package](library/ethereum_test_exceptions.md)
* [Ethereum Test Fixtures Package](library/ethereum_test_fixtures.md)
* [Ethereum Test Forks Package](library/ethereum_test_forks.md)
* [Ethereum Test Specs Package](library/ethereum_test_specs.md)
* [Ethereum Test Tools Package](library/ethereum_test_tools.md)
* [Ethereum Test Types Package](library/ethereum_test_types.md)
* [Ethereum Test VM Package](library/ethereum_test_vm.md)
* [Ethereum CLIs Package](library/ethereum_clis.md)
* [Pytest Plugins](library/pytest_plugins/index.md)
* [EEST CLI Tools](library/cli/index.md)
* [Ethereum Test Base Types Package](library/ethereum_test_base_types.md)
* [Ethereum Test Exceptions Package](library/ethereum_test_exceptions.md)
* [Ethereum Test Fixtures Package](library/ethereum_test_fixtures.md)
* [Ethereum Test Forks Package](library/ethereum_test_forks.md)
* [Ethereum Test Specs Package](library/ethereum_test_specs.md)
* [Ethereum Test Tools Package](library/ethereum_test_tools.md)
* [Ethereum Test Types Package](library/ethereum_test_types.md)
* [Ethereum Test VM Package](library/ethereum_test_vm.md)
* [Ethereum CLIs Package](library/ethereum_clis.md)
* [Pytest Plugins](library/pytest_plugins/index.md)
Loading
Loading