Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (53 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

69 lines (53 loc) · 2.81 KB

Contributing to qbit

qbit is developed as its own project. Do not use Bitcoin Core issue lists, IRC channels, mailing lists, GUI repository process, release process, or maintainer tools as the public contribution path for qbit.

The public contribution process is owned by the official qbit GitHub repository. Its public URL is launch-owned and still TBD, so this document keeps the reference generic until that URL is finalized.

Before You Start

  • Read the public docs index in doc/README.md.
  • For qbit-specific behavior, start with doc/user/bitcoin-core-differences.md.
  • Keep mainnet-facing docs gated behind "when launched" until qbit.org announces the public network and resource set.
  • Do not introduce Bitcoin Core security contacts, lifecycle links, issue links, IRC channels, mailing lists, or release-key references into qbit public docs.

Branch and PR Scope

Target develop unless a maintainer tells you otherwise. Keep changes focused on one layer or topic, and avoid mixing public docs, consensus behavior, wallet behavior, release tooling, and unrelated cleanup in the same pull request.

Use qbit names and paths in public-facing changes:

  • binaries such as qbitd, qbit-cli, qbit-qt, qbit-wallet
  • the qbit.conf config file
  • qbit data directories
  • qbit network flags and ports
  • qbit addresses and the qbit: payment URI scheme

Local Validation

For non-trivial changes, build and run the smallest relevant checks before opening or updating a pull request:

cmake --build build -j"$(sysctl -n hw.ncpu)"
RUST_BACKTRACE=1 cargo run --manifest-path ./test/lint/test_runner/Cargo.toml

Run focused unit and functional tests for the area you touched. For documentation-only public surface changes, also run targeted link/path audits and the public-source sanitizer dry run when sanitizer behavior changes.

Public Documentation Rules

  • Public docs must direct current release, network, support, faucet, explorer, and security-status questions to https://qbit.org unless a more specific qbit-owned public page has been finalized.
  • Mainnet examples must say they apply only when qbit mainnet is launched.
  • Testnet resource values must be tied to the relevant release candidate or network reset, not presented as permanent launch values.
  • The final public launch hash is TBD until a qbit launch announcement freezes it.
  • Public docs should reference finalized qbit-owned public resources only.
  • Unvalidated inherited docs should be unlisted, clearly labeled technical reference only, or stripped from sanitized public source snapshots.

Security Issues

Do not file security-sensitive qbit reports in public issues or send them to Bitcoin Core contacts. Use the qbit security channel announced on https://qbit.org once it is published.