Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

discussion:make testing.md more concise and decision-oriented for contributors

オープン
  • 何か問題がありますか？
#3,965 コメント 6 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
静か
技術スタック
javascript
領域
documentation, testing

調査の方向性

まず testing.md を読み、そこに記載されているクライアント側テストの構成を、issue で説明されているサーバー側の test/ パターンと比較します。変更を加える前に、maintainers に望ましいアプローチを確認してください。完了時の成果物は、受け入れられるテスト配置と contributor の次の手順を明確に説明する、簡潔で意思決定指向のガイドにしてください。

索引モデルが issue の本文から書いたものです。

説明

Area: Documentation Feature Request Needs Discussion
Increasing Access

While working across both the client and server codebases, I noticed that the repository currently follows two different test organization models, but only one of them is documented.

Client-side (documented): tests colocated adjacent to source files

Server-side (undocumented): tests grouped inside a dedicated test/ folder per module

Based on hands-on contribution experience, I strongly lean toward the server-style test-folder model as a more scalable and contributor-friendly approach, especially for larger directories.

Feature request details
Why this matters (practical impact)

In several client component directories, there are 20–25 files, where test and story files are mixed directly with production code. This has a few concrete downsides:

  • Contributors must repeatedly scan past test files to locate actual components
  • It becomes harder to visually distinguish production code vs test code
  • Directory navigation cost increases as the project grows
  • New contributors face higher cognitive load when exploring the codebase

By contrast, the server-side pattern:

module/
  controller.js
  service.js
  test/
    controller.test.js
    service.test.js

keeps production code immediately visible, while still maintaining strong test coverage.

This suggests the repository already has a proven, scalable testing model in use — just not consistently documented or discussed.

Documentation concern (testing.md)

Another related observation is that testing.md is currently very long (~550 lines) and highly procedural. While thorough, it can be overwhelming for contributors who just want to answer:

  • Where should I put my test?
  • What pattern should I follow in this part of the codebase?

This makes it harder to quickly internalize expectations, especially for first-time contributors.

Image

There may be an opportunity to:

  • Make the document more precise and decision-oriented
  • Clearly explain accepted test organization patterns
  • Reduce cognitive overhead without removing useful detail
Discussion points / questions

I’d love maintainer input on the following:

  1. Is the server-style test/ folder considered a preferred or more scalable pattern going forward?

  2. Would it make sense to explicitly support and document this model, at least for larger modules or new code?

  3. Should testing.md distinguish between:

    • Small components (adjacent tests acceptable)
    • Larger modules (grouped test folders recommended)?

  4. Is there interest in making testing.md more concise and guidance-focused, possibly with a short “Quick Start / Best Practices” section?
    Maintainers (@raclim ) wdyt?

主要言語
JavaScript
スター
1.7k
フォーク
1.7k
平均マージ
3日 7時間
マージ済み PR（30日）
8

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

processing/p5.js-web-editor のほかの issue

processing/p5.js-web-editor の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。