docs: distinguish contributor test prerequisites from minimal runtime dependencies
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 88/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
tests/run_all_tests.sh、tools/werror_switch_check.sh、CI の手順、およびリンクされた .devcontainer のコマンドと前提条件を確認したうえで、CONTRIBUTING.md を更新する。最小限のランタイム依存関係と、contributor 向けのビルド／テストツールを分離し、Git checkout と SHA-256 utility の要件も含める一方で、コマンドとテストの動作は変更しない。
索引モデルが issue の本文から書いたものです。
説明
The Getting Started section of CONTRIBUTING.md instructs contributors to build and run the full test suite, then says it requires only gcc. That describes the minimal runtime build incompletely and does not describe the contributor test environment.
Evidence and starting points
Checked at b91768e23c5a874a64e76e4af9ab291e6aa49983:
- CONTRIBUTING.md:7–14 puts the build and full-suite commands directly before the
gcc-only claim. tests/run_all_tests.shinvokesmaketo build test fixtures (for example lines 618, 645, and 725).- The sanitizer-classifier section explicitly makes missing Python 3 or Git checkout coverage fatal.
.devcontainer/already provides a prepared contributor environment and is linked in the root README.
This is source-confirmed; no full suite was run with tools removed from the machine.
First-contribution scope
Correct the Getting Started requirements, distinguishing the minimal runtime's lack of third-party library dependencies from the tools used to build and test it. Name Bash, the C build toolchain, Make, Python 3, Git, and standard Unix shell/build utilities as contributor prerequisites. In particular, the suite requires a SHA-256 utility (sha256sum or shasum; see tools/werror_switch_check.sh). Explain that the suite runs from a Git checkout, and link the existing devcontainer as a prepared option. Check the current suite and CI instructions for any further required tools before presenting a complete list.
Keep the change in the contribution guide; this issue does not ask for a new installer, environment redesign, or weaker tests. Basic Markdown and command-line familiarity are sufficient.
Done when
- A new contributor can distinguish runtime dependencies from build/test tools.
- The listed prerequisites agree with the actual build and suite commands.
- The guide explains the Git checkout requirement and links the prepared environment.
- Build/test commands and test behavior remain unchanged.
PR #1226 touches the issue-labelling section of the same document, but does not address these Getting Started requirements; rebase if it lands first.
- 主要言語
- C
- スター
- 3
- フォーク
- 7
- 平均マージ
- 3時間 58分
- マージ済み PR（30日）
- 105
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
InauguralSystems/EigenScript のほかの issue
-
area:lint-tooling bug
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1340 ·
メンテナーはふだん 1 日以内に返信
-
area:stdlib found-by:code-review kind:silent-wrong
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1338 ·
メンテナーはふだん 1 日以内に返信
-
area:lint-tooling found-by:critic kind:docs-drift
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
InauguralSystems/EigenScript#1335 ·
メンテナーはふだん 1 日以内に返信
-
area:ci found-by:critic kind:gate-defect
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
InauguralSystems/EigenScript#1311 ·
メンテナーはふだん 1 日以内に返信
-
enrolment: decide test_gc_runner_controls.py (exempt vs enrol) and whether floors need a ratchetオープンarea:gates found-by:critic kind:decision
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
InauguralSystems/EigenScript#1280 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
InauguralSystems/EigenScript の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
NabuCasa/silabs-firmware-builder#231 · コメント 1 件 ·
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
ClickHouse/pg_clickhouse#383 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信