[P2] Complete documentation and the v0.1 release gate #41

New issue

Open

opened 2026-07-18 00:04:42 +00:00 by lost-rob0t · 0 comments

lost-rob0t commented

2026-07-18 00:04:42 +00:00

(Migrated from github.com)

Goal

Make the first release installable, understandable, and honest about its privacy guarantees, test evidence, and limitations.

Documentation

Architecture and threat-model updates matching the implemented system.
Installation, configuration, provider, Qtile, ActivityWatch, Xorg, and optional Wayland guides.
Capture-state and emergency-stop behavior.
Redaction limitations and how to create sensitive-app/workspace policies.
Encryption, key recovery, rotation, backup, restore, retention, and deletion procedures.
Local-only verification and remote-provider egress behavior.
Troubleshooting and safe diagnostic collection.
TDD contributor workflow, regression-test requirements, test-layer ownership, and canonical test commands.
Explicit test failure semantics, including zero-test behavior and prohibited false-green constructs.

Release gate

All P0 and P1 issues closed or explicitly deferred with rationale.
Every completed implementation issue includes automated tests covering its acceptance criteria and evidence that the relevant test failed before the implementation or bug fix.
Unit, integration, security/privacy invariant, and E2E suites execute their required tests and pass.
Deliberate failure-injection checks prove each canonical test command and required CI job returns non-zero for assertion failure, collection failure, process crash, timeout, setup/teardown failure, and zero-test selection.
No required test is skipped, disabled, marked expected-failure, filtered out, or quarantined at release time.
No required CI job uses continue-on-error, allow_failure, pass-with-no-tests behavior, swallowed failures, unconditional success exits, or equivalent escape routes.
Test pipelines preserve the original failing exit status, including when output is piped or captured.
No plaintext capture artifacts exist in repository, CI, packages, logs, diagnostics, or release assets.
Dependency and license review completed.
Signed/tagged v0.1 release with reproducible build instructions, exact test commands, test counts, and known limitations.

Acceptance criteria

The release cannot be produced when any required test path is false-green, empty, skipped, or failing.
The published test report states discovered, executed, passed, failed, skipped, and expected-failure counts for every required suite.
All required skipped and expected-failure counts are zero.

Depends on

## Goal Make the first release installable, understandable, and honest about its privacy guarantees, test evidence, and limitations. ## Documentation - Architecture and threat-model updates matching the implemented system. - Installation, configuration, provider, Qtile, ActivityWatch, Xorg, and optional Wayland guides. - Capture-state and emergency-stop behavior. - Redaction limitations and how to create sensitive-app/workspace policies. - Encryption, key recovery, rotation, backup, restore, retention, and deletion procedures. - Local-only verification and remote-provider egress behavior. - Troubleshooting and safe diagnostic collection. - TDD contributor workflow, regression-test requirements, test-layer ownership, and canonical test commands. - Explicit test failure semantics, including zero-test behavior and prohibited false-green constructs. ## Release gate - All P0 and P1 issues closed or explicitly deferred with rationale. - Every completed implementation issue includes automated tests covering its acceptance criteria and evidence that the relevant test failed before the implementation or bug fix. - Unit, integration, security/privacy invariant, and E2E suites execute their required tests and pass. - Deliberate failure-injection checks prove each canonical test command and required CI job returns non-zero for assertion failure, collection failure, process crash, timeout, setup/teardown failure, and zero-test selection. - No required test is skipped, disabled, marked expected-failure, filtered out, or quarantined at release time. - No required CI job uses `continue-on-error`, `allow_failure`, pass-with-no-tests behavior, swallowed failures, unconditional success exits, or equivalent escape routes. - Test pipelines preserve the original failing exit status, including when output is piped or captured. - No plaintext capture artifacts exist in repository, CI, packages, logs, diagnostics, or release assets. - Dependency and license review completed. - Signed/tagged v0.1 release with reproducible build instructions, exact test commands, test counts, and known limitations. ## Acceptance criteria - The release cannot be produced when any required test path is false-green, empty, skipped, or failing. - The published test report states discovered, executed, passed, failed, skipped, and expected-failure counts for every required suite. - All required skipped and expected-failure counts are zero. ## Depends on - #4 - #38 - #39 - #40