stacks-network/stacks-core

[docs] Better documentation on how to run tests

Open

#6.990 aberto em 13 de mar. de 2026

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (758 forks)auto 404
choredocumentationhelp wanted

Métricas do repositório

Stars
 (3.063 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Revise o arquivo CONTRIBUTING.md e o pull request #6927 para entender a nova variável de ambiente BITCOIND TEST. Em seguida, atualize a documentação para explicar como executar testes localmente, incluindo quando BITCOIND TEST=1 é necessário.
Pilha de tecnologia
rust
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90