Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Fix `README`, `CONTRIBUTING`, and `AGENTS` drift

Chiusa
  • Qualcosa non va?
#634 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

@varex83agent ci sta già lavorando.

Dal 17/8/2026.

  • #650 di @varex83agent — aperta

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
docker, rust
Ambito
developer-experience, devops, documentation

Direzione di ricerca

Inizia leggendo README.md, CONTRIBUTING.md e AGENTS.md insieme all’albero dei crate del workspace, a Dockerfile, a test-infra/ e al cli.rs e alla documentazione del modulo indicati. Verifica nel repository le affermazioni elencate relative a toolchain, hook, profiling, compatibilità, quickstart, elenco dei crate e branding di Charon; evita di duplicare il lavoro di parità del README di cli tracciato in #584. Il lavoro è completato quando le discrepanze elencate nella documentazione e nei commenti sono corrette e le decisioni di mantenere o rinominare sono riflesse in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Summary

The top-level docs have drifted from the code in ways that actively mislead:

CONTRIBUTING.md

  • Claims nix develop provides the Rust toolchain — it doesn't (#598); also omits that quality gates need a nightly rustfmt, that smoke tests need Go, and that cargo test --all-features requires a running Docker daemon (eth2api's integration feature 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 omits third_party/ (load-bearing for charon interop in CI) and scripts/.

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.

Lingua principale
Rust
Stelle
8
Fork
6
Merge medio
4g 3h
PR unite (30g)
18

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NethermindEth/pluto

Tutte le issue di NethermindEth/pluto

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.