Skip to content

Write tests/e2e/README.md covering E2E setup and test authoring guide #287

Description

@Nursca

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

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions