See ROADMAP.md → good first issues and CONTRIBUTING.md → running the checks.
What / 要做什么
scripts/ has ~39 standalone .ts checks (onion-selftest.ts, mint-selftest.ts, relay-dos-test.ts, hs-rendezvous-test.ts, …) but no index of what each one covers, how long it takes, or when to run it. New contributors currently have to open each file to find out.
scripts/ 目录下有约 39 个独立的 .ts 检查脚本,但没有索引说明每个测什么、耗时多久、什么时候该跑。新人目前得逐个打开文件才知道。
Add scripts/README.md with a table: script name → one-line description (read from the file's own header comment, they mostly already have one) → rough runtime → run command (corepack pnpm exec tsx scripts/<name>.ts). Group by area (consensus/chain, onion routing, hidden services, relay/staking, mint, other) matching the module map in CONTRIBUTING.md.
Why this is a good first issue
Pure documentation, no code changes. Requires reading each script's header comment and running a few to note timing — good way to get a tour of the whole test surface.
Scope
New file scripts/README.md only. Link it from CONTRIBUTING.md's "running the checks" section once done.
See ROADMAP.md → good first issues and CONTRIBUTING.md → running the checks.
What / 要做什么
scripts/has ~39 standalone.tschecks (onion-selftest.ts,mint-selftest.ts,relay-dos-test.ts,hs-rendezvous-test.ts, …) but no index of what each one covers, how long it takes, or when to run it. New contributors currently have to open each file to find out.scripts/目录下有约 39 个独立的.ts检查脚本,但没有索引说明每个测什么、耗时多久、什么时候该跑。新人目前得逐个打开文件才知道。Add
scripts/README.mdwith a table: script name → one-line description (read from the file's own header comment, they mostly already have one) → rough runtime → run command (corepack pnpm exec tsx scripts/<name>.ts). Group by area (consensus/chain, onion routing, hidden services, relay/staking, mint, other) matching the module map inCONTRIBUTING.md.Why this is a good first issue
Pure documentation, no code changes. Requires reading each script's header comment and running a few to note timing — good way to get a tour of the whole test surface.
Scope
New file
scripts/README.mdonly. Link it fromCONTRIBUTING.md's "running the checks" section once done.