Description
New contributors who want to add E2E tests have no guide. Without documentation, they are likely to break the test setup or duplicate existing helper utilities.
Requirements and context
- Cover: prerequisites, how to run E2E tests locally, how the Docker node setup works, how to write a new test (with annotated example), available test helpers (funding accounts, ledger advance, indexer polling), how to debug a failing test
- Document the global setup sequence and teardown
Suggested execution
git checkout -b docs/e2e-readme
- Create
tests/e2e/README.md
- Link from org root
README.md
Example commit message
docs(e2e): write E2E setup guide and test authoring documentation
Description
New contributors who want to add E2E tests have no guide. Without documentation, they are likely to break the test setup or duplicate existing helper utilities.
Requirements and context
Suggested execution
tests/e2e/README.mdREADME.mdExample commit message
docs(e2e): write E2E setup guide and test authoring documentation