stacks-network/stacks-core

[docs] Better documentation on how to run tests

Open

#6 990 ouverte le 13 mars 2026

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Rust (758 forks)auto 404
choredocumentationhelp wanted

Métriques du dépôt

Stars
 (3 063 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le fichier CONTRIBUTING.md et la pull request référencée #6927 pour comprendre la nouvelle variable d'environnement BITCOIND TEST. Mettez ensuite à jour la documentation pour expliquer comment exécuter les tests localement, y compris quand BITCOIND TEST=1 est nécessaire.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90