Skip to content
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

docs: add required softwares to run tests in Contributing.md #627

Merged
merged 3 commits into from
Apr 24, 2024

Conversation

NicolasWent
Copy link
Contributor

Motivation

I was unable to run the tests for alloy (Cf #626) it was due to missing the geth and Anvil software.

Solution

I have added the requirements in the Contributing.md file so that other developers can directly see that they are needed.

I specified geth v1.13.x because testsuite doesn't work for now on latest geth version: geth v1.14.0

But the testsuite may work in future geth release, I am not sure that fixing the version to 1.13.x is a good idea because we will have to change it manually every time we upgrade. And anyways, when we run cargo test with geth v1.14.0 it tells us to use `geth v1.13.x

PR Checklist

Only Text modification no code change

I was unable to run the tests for alloy (Cf alloy-rs#626) it was due to missing the `geth` and `Anvil` software.

I have added the requirements in the `Contributing.md` file so that other developers can directly see that they are needed.

I specified `geth v1.13.x` because testsuite doesn't work for now on latest geth version: `geth v1.14.0`

But the testsuite may work in future geth release, I am not sure that fixing the version to `1.13.x` is a good idea. (Anyway when we run `cargo test` with `geth v1.14.0` it tells us to use `geth v1.13.x)
@DaniPopes
Copy link
Member

It's an error if alloy doesn't work with the latest geth version, so please remove the 1.13.x

@onbjerg onbjerg added the documentation Improvements or additions to documentation label Apr 24, 2024
@onbjerg onbjerg changed the title Add required softwares to run tests in Contributing.md docs: add required softwares to run tests in Contributing.md Apr 24, 2024
@onbjerg onbjerg merged commit e9d73d1 into alloy-rs:main Apr 24, 2024
18 checks passed
@NicolasWent NicolasWent deleted the patch-1 branch April 24, 2024 18:45
ben186 pushed a commit to ben186/alloy that referenced this pull request Jul 27, 2024
…s#627)

* Add required softwares to run tests in Contributing.md

I was unable to run the tests for alloy (Cf alloy-rs#626) it was due to missing the `geth` and `Anvil` software.

I have added the requirements in the `Contributing.md` file so that other developers can directly see that they are needed.

I specified `geth v1.13.x` because testsuite doesn't work for now on latest geth version: `geth v1.14.0`

But the testsuite may work in future geth release, I am not sure that fixing the version to `1.13.x` is a good idea. (Anyway when we run `cargo test` with `geth v1.14.0` it tells us to use `geth v1.13.x)

* [Contributing.md] Changed the fixed version on geth

* Update CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants