stacks-network/stacks-core

[docs] Better documentation on how to run tests

Open

#6.990 geöffnet am 13. März 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (758 Forks)auto 404
choredocumentationhelp wanted

Repository-Metriken

Stars
 (3.063 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die Datei CONTRIBUTING.md und den referenzierten Pull Request #6927, um die neue Umgebungsvariable BITCOIND TEST zu verstehen. Aktualisieren Sie dann die Dokumentation, um zu erklären, wie Tests lokal ausgeführt werden, einschließlich wann BITCOIND TEST=1 benötigt wird.
Tech Stack
rust
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90