docs: design principles & opinionated choices spec#324
Merged
Conversation
A shared reference for triaging issues and reviewing contributions: purpose and non-goals, the mock/session/history model, the opinionated choices (append-only called sessions, order-based priority, self-contained mocks, case-sensitive matching, ...), the frozen format/API stability contract, the quality bar, and a checklist for judging an issue or PR. Sourced from maintainer decisions in the referenced issues. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
docs/PRINCIPLES.md— a shared reference for triaging issues and reviewingcontributions. It's descriptive of decisions already made (sourced from maintainer
answers in issue threads, referenced inline), not a roadmap.
Contents:
not an outbound-webhook simulator, not a production gateway.
history + verification.
order (no explicit field), self-contained mocks (no file refs), case-sensitive matching,
Go-template/Lua dynamic responses, opaque IDs, concurrency safety.
changes only, resilient persistence; enforced by golden + venom tests.
Meant to make issue/PR triage faster and more consistent by writing the implicit rules down.
🤖 Generated with Claude Code