Fix `README`, `CONTRIBUTING`, and `AGENTS` drift
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- docker, rust
調査の方向性
まず、README.md、CONTRIBUTING.md、AGENTS.mdを、workspaceのcrateツリー、Dockerfile、test-infra/、および参照されているcli.rsとモジュールドキュメントと併せて読みます。toolchain、hooks、profiling、互換性、quickstart、crate一覧、Charon-brandingに関して列挙されている主張をリポジトリと照合してください。#584で追跡されているcli READMEの同等性対応を重複して行わないでください。列挙されたドキュメントとコメントの不整合が修正され、維持または改名する判断が一貫して反映されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
The top-level docs have drifted from the code in ways that actively mislead:
CONTRIBUTING.md
- Claims
nix developprovides the Rust toolchain — it doesn't (#598); also omits that quality gates need a nightly rustfmt, that smoke tests need Go, and thatcargo test --all-featuresrequires a running Docker daemon (eth2api'sintegrationfeature uses testcontainers) — a contributor without Docker gets opaque failures. - Doesn't mention that the pre-push hook runs deny + machete + fmt + clippy + the full test suite.
- The profiling section fences TOML as ```rust and suggests
dhat = "latest", which isn't a valid version requirement.
README.md
- The "Version compatibility" section is copy-pasted from Charon ("two given versions of Charon are compatible if…") and never states Pluto's own promise or explains that the workspace version tracks the charon parity target.
- No build/install/quickstart at all — nothing about the Dockerfile, the published image, or
test-infra/; the examples list covers 6 of 11 examples.
AGENTS.md
- The crate listing is 8 crates out of date: missing
consensus,eth1wrap,featureset,frost,infosync,parsigex,priority,ssz; tree diagram omitsthird_party/(load-bearing for charon interop in CI) andscripts/.
Cross-cutting: user-visible "Charon" branding in Pluto help text and crate docs — cli.rs long_about strings ("Verify that Charon can…", "Creates a local charon cluster configuration"), pluto-cluster/pluto-tracing module docs titled "# Charon …". Each needs a deliberate keep-or-rename decision (file/flag names like charon-enr-private-key are compatibility surface and should stay).
crates/cli/README.md's inverted parity table is already tracked by #584 — don't duplicate it here, but note cli.rs#L38 says "pluto-enr-private-key" while the actual default filename is charon-enr-private-key; the code comment is the wrong one.
Proposed change
One pass per file fixing the enumerated items; add a minimal Build/Run/Test quickstart to the README.
- 主要言語
- Rust
- スター
- 8
- フォーク
- 5
- 平均マージ
- 3日 1時間
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NethermindEth/pluto のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
NethermindEth/pluto#719 ·
-
enhancement rust
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
NethermindEth/pluto#640 ·
-
rust
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
NethermindEth/pluto#638 · コメント 1 件 ·
-
enhancement rust
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
NethermindEth/pluto#635 ·
-
Improve `alpha test peers`: match Charon's probes; reduce timeouts対応中かも @varex83agent が 26 日前に担当しました。 オープンbug track:orchestration-cli
難易度 5/5 1週間以上 初心者へのやさしさ 28/100
NethermindEth/pluto#632 ·
NethermindEth/pluto の issue をすべて見る
似ている issue
-
area:io kernel-paused needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
bherbruck/solvecraft#7854 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
transit-audio/transit#159 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
HakanSeven12/OpenCADStudio#2257 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
priority: low ui
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
storytold/photocraft#9884 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
triage: new type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
Jagalite/superseedr#376 ·
メンテナーはふだん 1 日以内に返信