Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

BL-32: Contributor environment preflight check (dincli system doctor / scripts/preflight.sh)

未关闭
#245 2 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
github-actions, python, solidity

调研方向

Read dincli/cli/system.py, the onboarding guide, ci.yml, and CLAUDE.md to understand the existing command structure and checks. Implement the read-only preflight command or fallback script, then run it on a clean environment and verify each listed check, plain text output, and exit codes. Done when the command is referenced in Documentation/public/guides/getting-started.md.

由索引模型根据 Issue 内容生成。

描述

Approved enhancement

Summary

There is no single command that checks a developer's machine before they start work. Each of the following has already caused lost time:

  1. Python < 3.12 installed (repo requires >=3.12).
  2. forge / anvil not installed, or the wrong solc version (0.8.28 required).
  3. foundry/node_modules absent — without npm ci, forge test's parallel jobs race to fetch @openzeppelin/upgrades-core over npx into a shared cache, causing both test flakiness and unnecessary supply-chain exposure at test time (documented in CLAUDE.md).
  4. eth-account or py-multibase not importable in the active venv.
  5. torch not importable (needed by tests/ full run and the reference service files).
  6. .env / .env.<network> missing, the configured RPC endpoint unreachable, or resolve_ipfs_config() unable to resolve.

Proposal

A read-only preflight check — dincli system doctor (preferred, fits the existing subcommand structure in dincli/cli/system.py) or scripts/preflight.sh as a fallback — that runs one check per line:

[OK]      Python 3.12.6
[OK]      forge 0.3.2 / anvil 0.3.2
[OK]      solc 0.8.28 (via solc-select)
[OK]      foundry/node_modules present
[OK]      eth-account 6.3.0
[OK]      py-multibase 2.0.1
[MISSING] torch — run: pip install torch
[OK]      .env.sepolia_op_devnet found
[OK]      RPC https://... → chainId 11155420
[MISSING] IPFS_API_URL not set and no Filebase credentials — see Documentation/public/guides/ipfs.md

Exits non-zero on any MISSING or ERROR row. Never installs anything itself — reports and exits.

Usage

  • Primary: first command in the onboarding docs (Documentation/public/guides/getting-started.md).
  • Secondary: first step in ci.yml's unit-test job (can replace the current ad-hoc pip install + forge --version calls).
  • Optional local alias: make doctor.

Acceptance

  • All six check categories above pass on a clean machine.
  • Exits 0 when everything is OK, non-zero when any check fails.
  • Output is plain text, one line per check, usable in CI without color codes (--no-color flag or auto-detect).
  • Documentation/public/guides/getting-started.md references the command.

References

  • Developer/BACK_LOG.md BL-32
  • CLAUDE.md — npm ci warning (§ Solidity)
  • Preflight pattern reviewed in Osomudeya/devops-scripting-labs (2026-10-02)
主要语言
Python
星标
4
派生
7
平均合并
3 天 5 小时
30 天内合并 PR
34

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

InfiniteZeroFoundation/DevNet 的其他 Issue

查看 InfiniteZeroFoundation/DevNet 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。