Skip to content

docs: document the end-to-end test suite - #798

Merged
mrbobbytables merged 2 commits into
mainfrom
docs/document-e2e-suite
Sep 28, 2026
Merged

mrbobbytables merged 2 commits into
mainfrom
docs/document-e2e-suite

Conversation

@mrbobbytables

Copy link
Copy Markdown
Member

The repository has a Playwright e2e suite (tests/e2e/, npm run test:e2e,
required "End-to-end tests" CI check) but no contributor-facing doc mentioned
it. Verified there are zero references in CONTRIBUTING.md/AGENTS.md/README.md.

Running it locally has two undocumented prerequisites (confirmed in
playwright.config.js/package.json):

  1. A production build must exist first — the suite serves build/, it does
    not build it.
  2. Playwright's chromium browser must be installed separately (npm ci does
    not fetch it).

Added an "End-to-end tests" section to CONTRIBUTING.md and a matching
Build & Test bullet to AGENTS.md documenting the commands and the
E2E_PORT override.

Fixes #764

CONTRIBUTING.md and AGENTS.md never mentioned the Playwright suite in
tests/e2e/, npm run test:e2e, or its two undocumented prerequisites: a
production build must exist first (the suite serves build/, it does
not build it) and Playwright's chromium browser must be installed
separately from npm ci.

Added an "End-to-end tests" section to CONTRIBUTING.md's Making
changes flow and a matching Build & Test bullet to AGENTS.md.

Fixes #764

Signed-off-by: mrbobbytables <mrbobbytables@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

No description provided.

# Conflicts:
#	AGENTS.md
#	CONTRIBUTING.md
@mrbobbytables
mrbobbytables added this pull request to the merge queue Sep 28, 2026
Merged via the queue into main with commit 8233d51 Sep 28, 2026
6 checks passed
@mrbobbytables
mrbobbytables deleted the docs/document-e2e-suite branch October 7, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[guide] E2E suite is invisible to contributors: no doc mentions test:e2e, the build prerequisite, or Playwright browser install

1 participant