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

docs: distinguish contributor test prerequisites from minimal runtime dependencies

Chiusa Adatta ai principianti
  • Qualcosa non va?
#1,239 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
bash, c, git, python
Ambito
build-system, documentation, testing

Direzione di ricerca

Aggiornare CONTRIBUTING.md dopo aver verificato i comandi e i prerequisiti in tests/run_all_tests.sh, tools/werror_switch_check.sh, nelle istruzioni CI e nel .devcontainer collegato. Separare le dipendenze minime di runtime dagli strumenti di build e test per i contributor, inclusi i requisiti per Git checkout e per l’utility SHA-256, lasciando invariati i comandi e il comportamento dei test.

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

Descrizione

area:docs documentation good first issue help wanted kind:docs-drift

The Getting Started section of CONTRIBUTING.md instructs contributors to build and run the full test suite, then says it requires only gcc. That describes the minimal runtime build incompletely and does not describe the contributor test environment.

Evidence and starting points

Checked at b91768e23c5a874a64e76e4af9ab291e6aa49983:

  • CONTRIBUTING.md:7–14 puts the build and full-suite commands directly before the gcc-only claim.
  • tests/run_all_tests.sh invokes make to build test fixtures (for example lines 618, 645, and 725).
  • The sanitizer-classifier section explicitly makes missing Python 3 or Git checkout coverage fatal.
  • .devcontainer/ already provides a prepared contributor environment and is linked in the root README.

This is source-confirmed; no full suite was run with tools removed from the machine.

First-contribution scope

Correct the Getting Started requirements, distinguishing the minimal runtime's lack of third-party library dependencies from the tools used to build and test it. Name Bash, the C build toolchain, Make, Python 3, Git, and standard Unix shell/build utilities as contributor prerequisites. In particular, the suite requires a SHA-256 utility (sha256sum or shasum; see tools/werror_switch_check.sh). Explain that the suite runs from a Git checkout, and link the existing devcontainer as a prepared option. Check the current suite and CI instructions for any further required tools before presenting a complete list.

Keep the change in the contribution guide; this issue does not ask for a new installer, environment redesign, or weaker tests. Basic Markdown and command-line familiarity are sufficient.

Done when

  • A new contributor can distinguish runtime dependencies from build/test tools.
  • The listed prerequisites agree with the actual build and suite commands.
  • The guide explains the Git checkout requirement and links the prepared environment.
  • Build/test commands and test behavior remain unchanged.

PR #1226 touches the issue-labelling section of the same document, but does not address these Getting Started requirements; rebase if it lands first.

Lingua principale
C
Stelle
3
Fork
7
Merge medio
8h 17m
PR unite (30g)
248

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 InauguralSystems/EigenScript

Tutte le issue di InauguralSystems/EigenScript

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.