Document why `node:test` exists
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 122k
- フォーク
- 37.3k
- 平均マージ
- 4日 2時間
- マージ済み PR(30日)
- 283
説明
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. 😕
- If it's relevant, my background: I'm primarily a maintainer of Node.js applications, ~5 years of experience doing so, and am not a maintainer of any OSS.
- I'm unsure how "should X go in core?" questions are usually settled, or if there are heuristics that exist in docs somewhere or in the heads of regular contributors. I went looking and found https://github.com/nodejs/node/blob/68fb0bf553e2af3e0b61733d29e1e9ba7f73d9b2/doc/contributing/pull-requests.md#accept-that-there-are-different-opinions-about-what-belongs-in-nodejs, which doesn't address the question so much as COC concerns at the periphery of the question. The couple “sufficient to put a thing in core” criteria it does identify aren’t met by a testing framework.
@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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず影響を受ける nodejs.org/api/test.html ページから始め、次にリンクされている提案 issue と、それが参照しているコメント、および doc/contributing/pull-requests.md を読みます。ドキュメントを変更する前に、node:test についてプロジェクトで合意された理由と目標を確認してください。ページがモジュールが存在する理由を明確に説明し、未解決の疑問に対処できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, node.js
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100