Skip to content

Contributing

BTF Kabir edited this page Jul 16, 2026 · 1 revision

Contributing

PRs welcome. Fork, open issues, send pull requests.

Maintainer: BTF Kabir (@BTF-Kabir-2020)

Quick path

  1. Fork → branch off main
  2. cargo test --workspace and .\scripts\quality.ps1 (Windows) or ./scripts/quality.sh
  3. Web CSS is the vendored Play CDN file (dns-cli/static/tailwindcss.js) — no Node build
  4. Open a PR with the template; keep secrets out of the diff

Good first areas: docs, safer web defaults, tests under dns-cli/tests/, FFI samples, smoke scripts, wiki improvements.

Rules

  • rustfmt + clippy -D warnings (CI)
  • Don't commit .env, real SLIPNET_CONFIG, or live passwords
  • Web stays localhost-first — see docs/SECURITY_WEB.md
  • Prefer focused PRs over mega-diffs
  • Do not add AI/tool Co-authored-by trailers; git author stays human

Full text: CONTRIBUTING.md · Code of conduct: CODE_OF_CONDUCT.md

By contributing you agree your changes are under the same non-commercial LICENSE.

Clone this wiki locally