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.

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

Jump to bottom

chore: add note in CONTRIBUTING about external test deps #5471

Merged
merged 2 commits into from
May 8, 2023
Merged

chore: add note in CONTRIBUTING about external test deps #5471

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23052cc
Add note in CONTRIBUTING about external test deps
dapplion May 8, 2023
230fe18
Update CONTRIBUTING.md
dapplion May 8, 2023
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
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,22 @@ Thanks for your interest in contributing to Lodestar. It's people like you that

## Tests

To run tests:

- :test_tube: Run `lerna run test:unit` for unit tests.
- :test_tube: Run `lerna run test:e2e` for end-to-end tests.
- :test_tube: Run `lerna run test:spec` for spec tests.
- :test_tube: Run `lerna run test` to run all tests.
- :test_tube: Run `yarn check-types` to check TypeScript types.
- :test_tube: Run `yarn lint` to run the linter (ESLint).

Contributing to tests:

- Test must not depend on external live resources, such that running tests for a commit must be deterministic:
- Do not pull data from external APIs like execution JSON RPC (instead run a local node).
- Do not pull unpinned versions from dockerhub (use deterministic tag) or Github (checkout commit not branch).
- Carefully design tests that depend on timing sensitive events like p2p network e2e tests. Consider that Github runners are significantly less powerful than your development environment.

### Debugging Spec Tests

- To fix errors always focus on passing all minimal tests first without running mainnet tests.
Expand Down