Skip to content

chore: Polishes docs, local run and CI before the signature step - #22

Merged
wcislom merged 8 commits into
mainfrom
chore/polishing
Oct 16, 2026
Merged

wcislom merged 8 commits into
mainfrom
chore/polishing

Conversation

@wcislom

@wcislom wcislom commented Oct 16, 2026 •

Copy link
Copy Markdown
Owner

Summary

Final polish of the MVP: the README describes what was built, run-local.sh applies the EF migrations, the docs
describe only what exists, and CI checks formatting.

Docs

  • README rewritten for a reviewer: observability section with a trace screenshot from the Aspire Dashboard,
    testing (acceptance scenarios, unit tests, CI, offline prompt evaluation), ADR table, known limitations,
    one-time setup for a manual run (deploy/.env, connection string in user secrets), license note.
    The "work in progress" status is gone.
  • Teamtailor webhook signature v2 removed from the docs. It was never implemented, so docs, rules,
    acceptance scenarios (I3, I4) and ADRs 003 and 004 no longer describe it. They come back together with the
    implementation. Teamtailor's own signature format stays documented in .claude/rules/teamtailor.md.
  • architecture.md: dotnet-tools.json added to the repository layout; the public surface of
    Infrastructure.Teamtailor lists only what exists (IWebhookParser and its result).
  • CLAUDE.md: the EF migration command points to the tool manifest instead of "verify once the first
    DbContext exists".
  • ADR 004: removed the leftover TODO: confirm this rationale.; the rationale itself is unchanged.
  • diagrams.md, e2e.http: span names as exported, link to the screenshot, setup steps via run-local.sh.

Local run

  • deploy/run-local.sh restores dotnet-ef and applies pending migrations for all three DbContexts after
    the build and before the hosts start, so neither the relay nor a worker meets a missing table.

CI and formatting

  • .editorconfig: spaces, indent 4 (2 for project, JSON and YAML files), final newline, no trailing whitespace.
    end_of_line is unset because the index holds LF and Windows checkouts get CRLF through core.autocrlf.
    charset is unset because dotnet ef writes migrations with a BOM.
  • CI Build job: new step dotnet format --verify-no-changes, which fails the PR on unformatted code.
  • Code: two is SqlException { Number: ... } patterns reformatted, the only existing dotnet format findings.
    Forward-looking TODO and doc comments about the signature removed. No behaviour change.

@wcislom
wcislom merged commit 7fbc72b into main Oct 16, 2026
3 checks passed
@wcislom
wcislom deleted the chore/polishing branch October 16, 2026 13:01
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