Skip to content

release: 0.0.1-alpha — first public alpha (docs, version, demo) - #14

Merged
hellno merged 1 commit into
mainfrom
hellno/content-filter-error
Jun 10, 2026
Merged

release: 0.0.1-alpha — first public alpha (docs, version, demo)#14
hellno merged 1 commit into
mainfrom
hellno/content-filter-error

Conversation

@hellno

@hellno hellno commented Jun 10, 2026

Copy link
Copy Markdown
Owner

What this is

Cuts Deckard 0.0.1-alpha — the first public alpha — and adds the contributor-facing scaffolding so others can build on and contribute to the project. It signals loudly that this is experimental software, not for production and not for real funds.

Changes

Version

  • Bumped all 4 crates 0.1.00.0.1-alpha and synced Cargo.lock (versions only — no dependency changes; inter-crate deps are path-only, so the pre-release string is safe).

README

  • Prominent alpha "not for real funds / testnet keys only / unaudited" banner near the top.
  • Embedded docs/demo.gif.
  • Status section reconciled to STATUS.md (does not overstate Send / Swap / MCP / receive-watcher).
  • Links to the new contributor + security docs.

New docs

  • CONTRIBUTING.md — clone → green-PR guide, the Definition of Done, code constraints, design rules.
  • SECURITY.md — private vulnerability disclosure, the security model, honest known-limitations.
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1.
  • CHANGELOG.md — Keep a Changelog, 0.0.1-alpha entry.
  • docs/RELEASING.md — maintainer release runbook.
  • .github/ — issue forms (bug / feature, routing security reports privately) + PR template that encodes the Definition of Done.

Demo

  • docs/demo.gifdraft recorded from the current build (onboarding → verified split-balance → command palette → receive QR → shield-to-private). The final cut is swapped in once the in-flight UI-polish branch lands.

Honesty pass

All docs were cross-checked against STATUS.md by an automated honesty + completeness review: no production-readiness implications, and Send / Swap / MCP / receive-watcher are consistently marked not-done.

Definition of Done

  • cargo fmt --all --check clean
  • ✅ clippy -D warnings green — default and --features tray ("No issues found")
  • cargo test --workspace — 87 passed, 1 ignored
  • ✅ No new / changed dependencies

Deliberately deferred (maintainer's call)

  • 🔒 Repo stays private — flipping to public is your decision (see docs/RELEASING.md §6).
  • 🏷️ Tag v0.0.1-alpha + GitHub pre-release happen after merge (tag the merge commit).
  • 🎬 Final demo GIF re-recorded + swapped once the UI-polish branch merges.

Signals the project as 0.0.1-alpha, experimental software (not for
production, not for real funds) and adds the contributor-facing
scaffolding so others can build on and contribute to it.

- Version: bump all 4 crates 0.1.0 -> 0.0.1-alpha + sync Cargo.lock
  (versions only; no dependency changes).
- README: prominent alpha "not for real funds" banner, demo GIF, and
  links to the new docs; Status reconciled to STATUS.md (no overstating
  Send/Swap/MCP/receive-watcher).
- New: CONTRIBUTING.md, SECURITY.md (private disclosure),
  CODE_OF_CONDUCT.md (Contributor Covenant 2.1), CHANGELOG.md
  (Keep a Changelog), docs/RELEASING.md runbook, GitHub issue forms +
  PR template (encodes the Definition of Done).
- docs/demo.gif: draft recorded from the current build; final cut
  swapped in after the in-flight UI polish lands.

Definition of Done: `cargo fmt --all --check` clean; clippy -D warnings
green on default + --features tray; `cargo test --workspace` 87 passed /
1 ignored. No new/changed dependencies.
@hellno
hellno merged commit 07b2304 into main Jun 10, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant