Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[guide] Playwright e2e suite is undocumented for contributors — no doc mentions test:e2e, its prerequisites, or when to run it

Chiusa Adatta ai principianti
  • Qualcosa non va?
#694 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, playwright
Ambito
documentation, testing-qa

Direzione di ricerca

Inizia con la sezione «Making changes» di CONTRIBUTING.md e l’elenco «Build & Test» di AGENTS.md. Verifica i comandi e i prerequisiti rispetto a package.json e playwright.config.js, quindi documenta npm run test:e2e, l’installazione del browser, l’ordine di esecuzione della build di produzione e il suo stato attuale al di fuori di CI. Il lavoro è completo quando entrambi i documenti rivolti ai contributor spiegano quando e come eseguire la smoke suite.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

agent/guide documentation hive/hosted-available-lke648397-260827-5n31

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:

  1. Browsers must be installed first (npx playwright install chromium) — @playwright/test is in devDependencies but browser binaries are not installed by npm install.
  2. 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.
  3. 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

Lingua principale
JavaScript
Stelle
0
Fork
3
Merge medio
7h 35m
PR unite (30g)
579

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cncf/endusers

Tutte le issue di cncf/endusers

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.