synapse/goatcounter-stats-gateway
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

docs: engineering standards (observability, documentation, coverage) #4

Merged
synapse merged 4 commits from docs/engineering-standards into develop 2026-08-21 03:33:29 +00:00
Conversation 0 Commits 4 Files changed 9 +168 -3
synapse commented 2026-08-21 02:57:01 +00:00
Owner
Copy link

Adds the Engineering Standards section to CLAUDE.md: observability-first (tracing + metrics for every externally visible behavior), documented source (purpose/invariant doc comments, why-comments), high test coverage (scenario→test mapping, failure modes via mocks, coverage gate once cargo-llvm-cov lands).

The planning-side counterpart landed in the OpenSpec store's config.yaml (local): project context plus per-artifact rules so every future proposal/spec/design/tasks is forced to carry observability requirements, failure-mode scenarios, and explicit test/logging/docs tasks.

🤖 Generated with Claude Code

https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9

Adds the Engineering Standards section to CLAUDE.md: observability-first (tracing + metrics for every externally visible behavior), documented source (purpose/invariant doc comments, why-comments), high test coverage (scenario→test mapping, failure modes via mocks, coverage gate once cargo-llvm-cov lands). The planning-side counterpart landed in the OpenSpec store's config.yaml (local): project context plus per-artifact rules so every future proposal/spec/design/tasks is forced to carry observability requirements, failure-mode scenarios, and explicit test/logging/docs tasks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
Implementation-side counterpart to the artifact rules now in the
OpenSpec store's config.yaml.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
OpenSpec scenarios -> hurl e2e (red first), utoipa-emitted OpenAPI
committed as snapshot with diff check; docs updated in the same PR
that changes what they describe.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
Three seed pages: introduction (why the gateway exists), architecture
(trust boundary, contract ownership, deploy shape), development guide.
mdbook in the devshell, book built as nix build .#docs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
Ready for the API change's e2e-TDD workflow (hurl file per scenario).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
synapse merged commit 557e4a1b99 into develop 2026-08-21 03:33:29 +00:00
synapse deleted branch docs/engineering-standards 2026-08-21 03:33:29 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
synapse/goatcounter-stats-gateway!4
No description provided.