docs: distinguish contributor test prerequisites from minimal runtime dependencies
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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
- 平均合并
- 4 小时 15 分钟
- 30 天内合并 PR
- 106
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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
-
bug needs triage
难度 2/5 1-3 小时 新手友好度 78/100
netdata/netdata#24062 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
-
难度 2/5 1-3 小时 新手友好度 88/100
BasedHardware/omi#19463 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
EchoTools/nevr-runtime#30 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
riscv-software-src/riscv-isa-sim#2448 ·
维护者通常 2 天内回复