stacks-network/stacks-core

[docs] Better documentation on how to run tests

Open

#6,990 opened on Mar 13, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (758 forks)auto 404
choredocumentationhelp wanted

Repository metrics

Stars
 (3,063 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the CONTRIBUTING.md file and the referenced pull request #6927 to understand the new BITCOIND TEST environment variable. Then update the documentation to explain how to run tests locally, including when BITCOIND TEST=1 is needed.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90