Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Cerrado
  • ¿Algo no está bien?
#634 3 comentarios 0 reacciones 0 asignados Ver en GitHub

@varex83agent ya está trabajando en esto.

Desde el 17/8/2026.

  • #650 de @varex83agent — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, rust
Área
developer-experience, devops, documentation

Línea de trabajo

Empieza leyendo README.md, CONTRIBUTING.md y AGENTS.md junto con el árbol de crates del workspace, Dockerfile, test-infra/, y el cli.rs y la documentación del módulo referenciados. Comprueba las afirmaciones enumeradas sobre toolchain, hooks, profiling, compatibilidad, quickstart, listado de crates y branding de Charon contra el repositorio; evita duplicar el trabajo de paridad del README de cli registrado en #584. El trabajo estará terminado cuando se hayan corregido las discrepancias enumeradas en la documentación y los comentarios, y las decisiones de conservar o renombrar se reflejen de forma coherente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Rust
Estrellas
8
Forks
5
Merge medio
3 d 1 h
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NethermindEth/pluto

Todos los issues de NethermindEth/pluto

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.