Skip to content

V1 release pass: polish first-time user path for 0.1.0 - #30

Merged
dottie-weaver merged 7 commits into
mainfrom
dottie/v1-release-pass
May 31, 2026
Merged

V1 release pass: polish first-time user path for 0.1.0#30
dottie-weaver merged 7 commits into
mainfrom
dottie/v1-release-pass

Conversation

@dottie-weaver

Copy link
Copy Markdown
Contributor

Closes #18

This PR bundles the release-pass sub-issues that polish hud for a public 0.1.0:

CI: ./scripts/check passes all 39 tests (30 unit, 8 CLI integration, 1 example validation). cargo fmt is clean.

Why a single PR: These are all sub-issues of #18 and each commit addresses exactly one issue. The commits are ordered to be independently reviewable — but since they all land before the 0.1.0 tag, a single PR keeps the merge sequence clean.

Closes #28

Add CHANGELOG.md with Keep-a-Changelog format covering all V1 capabilities
and known limitations. Verified: ./scripts/check passes.
- Extract Cli struct and parse() from main.rs into src/cli.rs as a public module
- Add assert_cmd + predicates dev-dependencies for integration tests
- Add tests/cli.rs with 8 integration tests covering all acceptance criteria:
  --help, --version, --demo --check-config, --config kitchen-sink, --config dogfood,
  unknown argument, missing config file, --config without path
- Add 5 unit tests for Cli::parse() in src/cli.rs
- All 33 tests pass (25 existing + 8 new integration + 5 new unit, 5 unit overlap with parse coverage)

Closes #19
- Add LICENSE file with standard MIT license, copyright 2026 Travis Nesland
- Add description, license, repository, and readme fields to Cargo.toml
- Package metadata verified via cargo metadata --no-deps

Closes #25
- Add tests/examples.rs that discovers all examples/*.toml and validates
  each with HudConfig::load_from_path (the real config parser)
- Future example configs are automatically covered
- A broken example config will now fail ./scripts/check

Closes #21
- Add examples/starter.toml: self-contained config using only printf, date,
  and pwd — no external tools or authentication required
- Polish examples/kitchen-sink.toml: remove gh action (assumes auth),
  replace issue table with generic service table, clarify orientation text
- All examples validated by ./scripts/check and --check-config

Closes #24
- Add Quality Policy section to AGENTS.md
- ./scripts/check is the local definition of done
- Behavior changes need automated coverage or documented exception
- Docs-only changes must leave the repo green

Closes #20
@dottie-weaver
dottie-weaver merged commit 54edc7b into main May 31, 2026
1 check passed
@dottie-weaver
dottie-weaver deleted the dottie/v1-release-pass branch May 31, 2026 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant