Skip to content

fix(docs): add missing lines code coverage field to eip checklist #2137

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

Merged
spencer-tb merged 4 commits into from
Feb 5, 2026
Merged

fix(docs): add missing lines code coverage field to eip checklist #2137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1eb23a0
fix(docs): docs ci build failed due to being in strict mode and emitt…
felix314159 Feb 4, 2026
3fc0916
fix: disable strict mode for building docs, only errors should lead t…
felix314159 Feb 4, 2026
523e34d
fix: info warnings about missing navigation elements that spam ci output
felix314159 Feb 4, 2026
977c339
PR feedback
felix314159 Feb 5, 2026
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
15 changes: 14 additions & 1 deletion docs/navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
* [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)
* Tutorials
* [Adding a State Test](writing_tests/tutorials/state_transition.md)
* [Adding a Blockchain Test](writing_tests/tutorials/blockchain.md)
* [Opcode Metadata](writing_tests/opcode_metadata.md)
* [Porting Legacy Tests](writing_tests/porting_legacy_tests.md)
* [Filling Tests](filling_tests/index.md)
* [Getting Started](filling_tests/getting_started.md)
Expand All @@ -48,6 +51,7 @@
* [Blockchain Engine Tests](running_tests/test_formats/blockchain_test_engine.md)
* [Blockchain Engine X Tests](running_tests/test_formats/blockchain_test_engine_x.md)
* [Transaction Tests](running_tests/test_formats/transaction_test.md)
* [Blockchain Sync Tests](running_tests/test_formats/blockchain_test_sync.md)
* [Common Types](running_tests/test_formats/common_types.md)
* [Exceptions](running_tests/test_formats/exceptions.md)
* [Hive](running_tests/hive/index.md)
Expand All @@ -65,6 +69,7 @@
* [Execute Hive](./running_tests/execute/hive.md)
* [Execute Remote](./running_tests/execute/remote.md)
* [Execute Eth Config](./running_tests/execute/eth_config.md)
* [Transaction Metadata](./running_tests/execute/transaction_metadata.md)
* [Useful Pytest Options](running_tests/useful_pytest_options.md)
* [Developer Doc](dev/index.md)
* [Managing Configurations](dev/configurations.md)
Expand All @@ -75,9 +80,14 @@
* [Logging](dev/logging.md)
* [Enabling Precommit Checks](dev/precommit.md)
* [Running Github Actions Locally](dev/test_actions_locally.md)
* [Dependencies and Packaging](dev/deps_and_packaging.md)
* [Changelog](CHANGELOG.md)
* [Changelog Section Template](changelog_section_template.md)
* [Library Reference](library/index.md)
* [EEST CLI Tools](library/cli/index.md)
* [eest](library/cli/eest.md)
* [evm_bytes](library/cli/evm_bytes.md)
* [extract_config](library/cli/extract_config.md)
* [Execution Testing Base Types Package](library/execution_testing_base_types.md)
* [Execution Testing Exceptions Package](library/execution_testing_exceptions.md)
* [Execution Testing Fixtures Package](library/execution_testing_fixtures.md)
Expand All @@ -88,3 +98,6 @@
* [Execution Testing VM Package](library/execution_testing_vm.md)
* [Execution Testing Client CLIs Package](library/execution_testing_client_clis.md)
* [Pytest Plugins](library/pytest_plugins/index.md)
* [Filler](library/pytest_plugins/filler.md)
* [Forks](library/pytest_plugins/forks.md)
* [Spec Version Checker](library/pytest_plugins/spec_version_checker.md)
3 changes: 2 additions & 1 deletion docs/writing_tests/checklist_templates/eip_testing_checklist_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Depending on the changes introduced by an EIP, the following template is the min
| ID | Description | Status | Tests |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ----- |
| `general/code_coverage/eels` | Run produced tests against [EELS](https://github.com/ethereum/execution-specs) and verify that line code coverage of new added lines for the EIP is 100%, with only exceptions being unreachable code lines. | | |
| `general/code_coverage/test_coverage` | Run coverage on the test code itself (as a basic logic sanity check), i.e., `uv run fill --cov tests`. | | |
| `general/code_coverage/test_coverage` | Run coverage on the test code itself (as a basic logic sanity check), i.e., `uv run fill --cov tests`. | | |
| `general/code_coverage/missed_lines` | Document any lines missed in coverage reports and explain why they are acceptable (e.g., unreachable code, general infrastructure not related to the EIP). | | |

@danceratopz danceratopz Feb 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This fixes this docs warning about a missing checklist item:

WARNING -  Item ID general/code_coverage/missed_lines not found in checklist template for EIP 7708

So re removing --strict: Isn't it good that the docs flagged this and that you're now fixing it?

| `general/code_coverage/second_client` | Optional - Run against a second client and verify sufficient code coverage over new code added for the EIP. | | |

#### Fuzzing
Expand Down