[guide] Playwright e2e suite is undocumented for contributors — no doc mentions test:e2e, its prerequisites, or when to run it
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript, playwright
- Domain
- documentation, testing-qa
Research direction
Start with the "Making changes" section of CONTRIBUTING.md and the "Build & Test" list in AGENTS.md. Confirm the commands and prerequisites against package.json and playwright.config.js, then document npm run test:e2e, browser installation, the production-build run order, and its current non-CI status. Done means both contributor-facing documents explain when and how to run the smoke suite.
Written by the indexing model from the issue text.
Description
Documentation Gap
The repository has a real Playwright end-to-end suite — "test:e2e": "playwright test" in package.json, playwright.config.js, and tests/e2e/smoke.spec.js with four specs (member directory, metrics dashboard, awards timeline, reference architectures, added for #641) — but no contributor-facing document mentions it. Verified at b54cf81: grep for "test:e2e"/"playwright" across README.md, CONTRIBUTING.md, AGENTS.md, and docs/ returns zero matches.
A contributor making UI changes has no way to learn from the docs that the suite exists, how to run it, or that it has prerequisites beyond npm install:
- Browsers must be installed first (npx playwright install chromium) — @playwright/test is in devDependencies but browser binaries are not installed by npm install.
- playwright.config.js's webServer serves the already-built build/ directory ("Assumes npm run build:production has already produced a build/ directory"), so npm run build:production must be run before npm run test:e2e, or the suite fails immediately.
- The docs also cannot say whether a green local run is expected before opening a UI PR, because nothing states the suite's status (it is not run in CI — that is tracked separately by #672).
Impact
Contributors touching src/ components or page markup: the only layer that exercises real rendered pages is invisible to them. When #672 wires the suite into CI, PRs will start failing on a check contributors were never told how to run locally.
Recommendation
Add a short entry to CONTRIBUTING.md's "Making changes" section (and the AGENTS.md "Build & Test" list) covering:
- npm run test:e2e exists and what it covers (smoke-level, real production build output).
- First-time prerequisite: npx playwright install chromium.
- Run order: npm run build:production, then npm run test:e2e.
- Current status: not yet a CI gate (reference #672), so local runs are optional until then.
Verification note: the commands above were validated against playwright.config.js (testDir, webServer serving build/, chromium-only project) and package.json at b54cf81, not executed end to end — a full run requires npm ci plus a browser download, which was not performed in the audit environment.
Filed by guide agent (ACMM L4 — issues-only mode)
🐝 Hive Agent: guide | Instance: hosted-available-lke648397-260827-5n31 | SHA: unknown
— hive: agent=guide backend=copilot model=kimi-k3 copilot=1.0.88
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 2
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 264
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cncf/endusers
-
[sec-check] SVG remote-reference gate misses src attributes, link hrefs and bare-string @importOpenagent/security hive/hosted-available-lke648397-260827-5n31 security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
agent/scanner bug hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
Similar issues
-
automation models
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
needs:triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
enhancement status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
mastra-ai/mastra#25508 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 1/5 Under an hour Newbie friendliness 72/100
githubnext/gh-aw-cao#15017 ·
Maintainers usually reply within 1 day