nodejs / nodejs/node

Document why `node:test` exists

Offen
#42,902 6 Kommentare 7 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

doc test_runner
Vorherrschende Sprache
JavaScript
Sterne
122k
Forks
37.3k
Ø Merge
4 T. 2 Std.
Gemergte PRs (30 T.)
283

Beschreibung

Affected URL(s)

https://nodejs.org/api/test.html

Description of the problem

Background

The core module node:test was proposed in https://github.com/nodejs/node/issues/40954 and shipped at Experimental stability in 18.0.0 via https://github.com/nodejs/node/pull/42325. Dozens of people expressed support for the idea via 👍 reactions and written comments. The sentiment of commenters toward the feature is overwhelmingly supportive.

Problem

TL;DR the questions asked in https://github.com/nodejs/node/issues/40954#issuecomment-1037512376 seem unanswered, reducing the likelihood that node:test becomes adopted.

It's unclear what problems the project aims to solve by including a test runner in core.

...or should I say—given the broad support shown by participants in https://github.com/nodejs/node/issues/40954 —that they're unclear to me. 😕

@bcomnes had a comment here - https://github.com/nodejs/node/issues/40954#issuecomment-1037512376 - that resonated very much with me: It distilled and synthesized a lot of rough ideas that commenters had submitted up to that point. IMO his comment effectively highlights the variety of goals that people might have for the module. It seems to me that the questions he raised remain unanswered.

cc @nodejs/test_runner (which I saw referenced in https://github.com/nodejs/TSC/issues/1194#issuecomment-1088280424 as a recently formed team)

meta note: My framing of this as a docs request might not be the best. If this is more suited as a Discussion or other type of issue, please let me know. Thanks.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der betroffenen Seite nodejs.org/api/test.html, lies dann den verlinkten Proposal-Issue und den darin referenzierten Kommentar sowie doc/contributing/pull-requests.md. Bestätige die im Projekt vereinbarte Begründung und die Ziele für node:test, bevor du die Dokumentation änderst; als erledigt gilt die Aufgabe, wenn die Seite klar erklärt, warum das Modul existiert, und die offenen Fragen behandelt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, node.js
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.