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

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

Chiusa Adatta ai principianti
  • Qualcosa non va?
#764 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

Direzione di ricerca

Leggi CONTRIBUTING.md e AGENTS.md insieme a package.json e playwright.config.js per confermare gli script esistenti, il prerequisito di build, l'installazione del browser, la porta e la posizione delle specifiche. Documenta il workflow end-to-end in entrambe le guide per i contributori, quindi verifica che le istruzioni corrispondano alla configurazione del repository e descrivano chiaramente quando la configurazione è completa.

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 Playwright end-to-end suite (tests/e2e/, wired as npm run test:e2e in package.json, expanded in #751), but no contributor-facing document mentions it. Verified at 26946ba:

  • grep -rn 'playwright\|test:e2e' CONTRIBUTING.md AGENTS.md README.md docs/ returns zero relevant matches (the only hit is an unrelated architecture record).
  • CONTRIBUTING.md "Making changes" (step 3) and AGENTS.md "Build & Test" list only npm run test:unit / npm run check / npm run build. A contributor editing components or pages has no documented way to know the e2e suite exists, let alone how to run it.
  • Running it has two undocumented prerequisites, both confirmed in playwright.config.js and package.json:
    1. A production build must exist first — the config comment states it "Assumes npm run build:production has already produced a build/ directory", and its webServer only serves that output (npx docusaurus serve), it does not build.
    2. Playwright browsers must be installed — @playwright/test (^1.63.0) does not download browsers on npm ci; a fresh checkout needs npx playwright install chromium (the suite's only configured project) per the official Playwright docs.

Impact

New contributors and agents following CONTRIBUTING.md/AGENTS.md never exercise the e2e layer locally, so e2e failures surface only after the fact. It also undercuts #672 (wiring e2e into CI): even once CI runs the suite, contributors still won't know how to reproduce or debug those failures locally.

Recommendation

Add a short "End-to-end tests" subsection to CONTRIBUTING.md (and a matching bullet in AGENTS.md "Build & Test") documenting:

npm run build:production      # required first: the suite serves build/, it does not build
npx playwright install chromium   # once per machine: downloads the browser
npm run test:e2e

Note that the suite starts its own server on localhost:3000 (override with E2E_PORT) and that specs live in tests/e2e/.

Verification disclosure: commands were validated against package.json scripts and playwright.config.js in-repo, and the browser-install step against the official Playwright documentation; they were not executed end-to-end in a fresh environment (no local dependency install performed for this audit).

Related: #672 tracks running this suite in CI (a separate deliverable).

Filed by guide agent (ACMM L4 — issues-only mode)

🐝 Hive Agent: guide | Instance: hosted-available-lke648397-260827-5n31 | SHA: 26946ba

— hive: agent=guide backend=copilot model=kimi-k3 copilot=1.0.88

Lingua principale
JavaScript
Stelle
0
Fork
2
Merge medio
1g 5h
PR unite (30g)
264

Preparare l'ambiente

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.