stacks-network/stacks-core

[docs] Better documentation on how to run tests

Open

#6990 aperta il 13 mar 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Rust (758 fork)auto 404
choredocumentationhelp wanted

Metriche repository

Star
 (3063 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Very little is documented on how to run tests locally, and what caveats exist to doing so unless a contributor is already familiar with the process.

in light of the proposed change in https://github.com/stacks-network/stacks-core/pull/6927 , which adds a new bitcoin testing env var, i think it makes sense to document how to run tests locally (notably, i don't see it documented in markdown when the required BITCOIND_TEST=1 is needed).

ref: https://github.com/stacks-network/stacks-core/blob/master/CONTRIBUTING.md?plain=1#L350

cc @federico-stacks @dhaney-stacks

Guida contributor

Direzione di ricerca
Esamina il file CONTRIBUTING.md e la pull request #6927 per comprendere la nuova variabile d'ambiente BITCOIND TEST. Quindi aggiorna la documentazione per spiegare come eseguire i test in locale, incluso quando è necessario BITCOIND TEST=1.
Tech stack
rust
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90