docs: update CONTRIBUTING.md for `uv` and `ruff` by danceratopz · Pull Request #1396 · ethereum/execution-specs

danceratopz · 2025-09-01T13:16:53Z

What was wrong?

CONTRIBUTING.md still referred to black, isort and didn't prefix entrypoints with uv; still referred to git submodules.
.gitmodules was empty/unused.

How was it fixed?

Updated CONTRIBUTING.md and removed .gitmodules.

Cute Animal Picture

CONTRIBUTING.md

codecov-commenter · 2025-09-01T18:51:33Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.94%. Comparing base (51cabd8) to head (7396ac7).
⚠️ Report is 1004 commits behind head on forks/osaka.

Additional details and impacted files

@@             Coverage Diff              @@
##           forks/osaka    #1396   +/-   ##
============================================
  Coverage        94.94%   94.94%           
============================================
  Files              583      583           
  Lines            34665    34665           
  Branches          3070     3070           
============================================
  Hits             32914    32914           
  Misses            1198     1198           
  Partials           553      553

Flag	Coverage Δ
unittests	`94.94% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

CONTRIBUTING.md

gurukamath · 2025-09-02T13:02:51Z

CONTRIBUTING.md

-$ mypy src                          # Verifies type annotations.
-$ pytest -n 4                       # Runs tests parallelly.
-$ pytest -m "not slow"              # Runs tests which execute quickly.
+tox -e static        # Run linting and type checking.


Not sure if we still need this after the commands above.

The aim was have a one-liner to copy-paste for those unfamiliar with tox (and don't know the -e flag).

CONTRIBUTING.md

danceratopz

Small suggestions regarding tox as it's not a dependency of EELS; new users will either need to install it or simply use uvx tox.

CONTRIBUTING.md

Co-authored-by: Guruprasad Kamath <guru241987@gmail.com>

CONTRIBUTING.md

…innet blocks

SamWilsn · 2025-09-10T17:05:03Z

CONTRIBUTING.md

- * `geth` installed and present in `$PATH`
+- [`uv`](https://docs.astral.sh/uv/) package manager,
+- Python 3.11.x,
+- [PyPy](https://www.pypy.org/) [7.3.19](https://downloads.python.org/pypy/) or later (typically only required by execution-specs maintainers),


Anyone running tox locally will have to have PyPy installed.

SamWilsn · 2025-09-10T17:06:10Z

CONTRIBUTING.md

+- [`uv`](https://docs.astral.sh/uv/) package manager,
+- Python 3.11.x,
+- [PyPy](https://www.pypy.org/) [7.3.19](https://downloads.python.org/pypy/) or later (typically only required by execution-specs maintainers),
+- `geth` installed and present in `$PATH` (only required by users who would like to sync and verify mainnet blocks using EELS; not required for typical specification or test development).


geth is required for execution-specs/tests/json_infra/test_ethash_general.py, but that's marked as a slow test so is never run. Syncing mainnet works with ~any client.

SamWilsn · 2025-09-10T17:09:48Z

CONTRIBUTING.md

+It is recommended to run the `static` checks locally before pushing changes to a pull request:

-`execution-specs` depends on a submodule that contains common tests that are run across all clients, so we need to clone the repo with the --recursive flag. Example:
 ```bash
-$ git clone --recursive https://github.com/ethereum/execution-specs.git
+uvx tox -e static        # Run linting and type checking.
 ```

-Or, if you've already cloned the repository, you can fetch the submodules with:
+All environments can be executed using (very slow, not recommended, even in parallel):

 ```bash
-$ git submodule update --init --recursive
+uvx tox
 ```


I don't think we should tell people not to run the full tox locally. I'd rather the recommendation be something like run tox -e static often during development, and tox once before opening your pull request.

SamWilsn · 2025-09-10T17:10:21Z

CONTRIBUTING.md

+Environments can be executed in parallel with (still very slow):
+
 ```bash
-$ tox
+uvx tox run-parallel
 ```


Is this a safe recommendation? The PyPy environment OOM'd in CI with 32GiB of memory.

SamWilsn · 2025-09-10T17:11:31Z

CONTRIBUTING.md

+uv run ethereum-spec-fill tests/eest --clean --fork Osaka -k eip7939
+```
+
+#### Spec Unit Tests


Suggested change

#### Spec Unit Tests

#### Debugging Tests

I might be missing the point of the subsection?

SamWilsn · 2025-09-10T17:12:57Z

CONTRIBUTING.md

 ### New Fork Tool
-----------------
+
 This tool can be used to create the base code for a new fork by using the existing code from a given fork.

 The command takes 4 arguments, 2 of which are optional
- * from_fork: The fork name from which the code is to be duplicated. Eg. - "Tangerine Whistle"
- * to_fork: The fork name of the new fork Eg - "Spurious Dragon"
- * from_test (Optional): Name of the from fork within the test fixtures in case it is different from fork name. Eg. - "EIP150"
- * to_test (Optional): Name of the to fork within the test fixtures in case it is different from fork name Eg - "EIP158"
+
+- from_fork: The fork name from which the code is to be duplicated. Eg. - "Tangerine Whistle"
+- to_fork: The fork name of the new fork Eg - "Spurious Dragon"
+- from_test (Optional): Name of the from fork within the test fixtures in case it is different from fork name. Eg. - "EIP150"
+- to_test (Optional): Name of the to fork within the test fixtures in case it is different from fork name Eg - "EIP158"

 As an example, if one wants to create baseline code for the `Spurious Dragon` fork from the `Tangerine Whistle` one

 ```bash
-ethereum-spec-new-fork --from_fork="Tangerine Whistle" --to_fork="Spurious Dragon" --from_test=EIP150 --to_test=EIP158
+uv run ethereum-spec-new-fork --from_fork="Tangerine Whistle" --to_fork="Spurious Dragon" --from_test=EIP150 --to_test=EIP158
 ```

 The following will have to however, be updated manually
+
 1. The fork number and `MAINNET_FORK_BLOCK` in `__init__.py`. If you are proposing a new EIP, please set `MAINNET_FORK_BLOCK` to `None`.
 2. Any absolute package imports from other forks eg. in `trie.py`
 3. Package names under `setup.cfg`
 4. Add the new fork to the `monkey_patch()` function in `src/ethereum_optimized/__init__.py`
 5. Adjust the underline in `fork/__init__.py`


This'll all get replaced when #1372 is merged.

…ic context to parse using mapper (ethereum#1396) * feat(clis,exceptions,specs): Pydantic validation using exception mapper * fix(specs): Skip block exception check on requests modifications * fix(docs): Links * fix(tests): EIP-4844: mark block as skip block exception verification * refactor(exceptions): Mapper mappings allow regex, convert from `property` to `ClassVar` * fix(docs): tox * chore(deps): remove now unused bdict dependency * Suggestions for ethereum#1396, refactor(exceptions,specs): Support general block exceptions - Pydantic context to parse using mapper (ethereum#1404) * refactor(fw): use enum helper; rename `ty` to `execution_context` * refactor(fw): use more specific names for exception classes * fix(tests): Add comment explaining `skip_exception_verification` * feat(clis): Add `reliable` flag to exception mapper class * fix: tests * fix(specs,clis,tools): Use `default_t8n` and remove `run_in_serial` from most unit tests * fix(specs): Bug and variable names * fix: bug * feat(clis/evmone): Add insufficient-blob-fee error * fix(tests): Allow similar blob exceptions * Apply suggestions from code review Co-authored-by: danceratopz <danceratopz@gmail.com> --------- Co-authored-by: danceratopz <danceratopz@gmail.com>

SamWilsn · 2025-12-15T20:34:17Z

I'm going to close this for now, but feel free to re-open against forks/amsterdam.

…ic context to parse using mapper (ethereum#1396) * feat(clis,exceptions,specs): Pydantic validation using exception mapper * fix(specs): Skip block exception check on requests modifications * fix(docs): Links * fix(tests): EIP-4844: mark block as skip block exception verification * refactor(exceptions): Mapper mappings allow regex, convert from `property` to `ClassVar` * fix(docs): tox * chore(deps): remove now unused bdict dependency * Suggestions for ethereum#1396, refactor(exceptions,specs): Support general block exceptions - Pydantic context to parse using mapper (ethereum#1404) * refactor(fw): use enum helper; rename `ty` to `execution_context` * refactor(fw): use more specific names for exception classes * fix(tests): Add comment explaining `skip_exception_verification` * feat(clis): Add `reliable` flag to exception mapper class * fix: tests * fix(specs,clis,tools): Use `default_t8n` and remove `run_in_serial` from most unit tests * fix(specs): Bug and variable names * fix: bug * feat(clis/evmone): Add insufficient-blob-fee error * fix(tests): Allow similar blob exceptions * Apply suggestions from code review Co-authored-by: danceratopz <danceratopz@gmail.com> --------- Co-authored-by: danceratopz <danceratopz@gmail.com>

docs: update CONTRIBUTING.md for uv and ruff

72bd744

danceratopz commented Sep 1, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

danceratopz added 3 commits September 1, 2025 16:40

chore: remove empty/unused .gitmodules file

006d0f6

docs: remove out-of-date git submodule docs from contributing

c52604c

docs: add a section explaining current state of the weld

42bc272

danceratopz marked this pull request as draft September 1, 2025 14:52

docs: second pass at contributing; correct commands

aba2239

danceratopz marked this pull request as ready for review September 2, 2025 09:48

Carsons-Eels self-requested a review September 2, 2025 13:25

gurukamath reviewed Sep 2, 2025

View reviewed changes

gurukamath mentioned this pull request Sep 2, 2025

chore(doc): Re-visit the tracing documentation for json_infra tests #1398

Open

danceratopz commented Sep 3, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

danceratopz and others added 2 commits September 3, 2025 07:30

Fix-up tox environment description via Guru's suggestion

d07de8d

Co-authored-by: Guruprasad Kamath <guru241987@gmail.com>

Prefix tox with uvx to prevent depdendency problems

980aa82

danceratopz requested a review from gurukamath September 3, 2025 05:35

Carsons-Eels reviewed Sep 3, 2025

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

Expand uv installation; running tox w/all envs not recommended

5ecd344

danceratopz commented Sep 4, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

docs: clarify that geth is only required for syncing and verifying ma…

7396ac7

…innet blocks

danceratopz requested review from Carsons-Eels and gurukamath and removed request for gurukamath September 4, 2025 15:12

Carsons-Eels approved these changes Sep 10, 2025

View reviewed changes

SamWilsn reviewed Sep 10, 2025

View reviewed changes

SamWilsn closed this Dec 15, 2025

Conversation

danceratopz commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What was wrong?

How was it fixed?

Cute Animal Picture

Uh oh!

Uh oh!

codecov-commenter commented Sep 1, 2025 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

danceratopz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamWilsn commented Dec 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

danceratopz commented Sep 1, 2025 •

edited

Loading

codecov-commenter commented Sep 1, 2025 •

edited by codecov bot

Loading