docs: trim go-testing-guide to rules-only (1207 → 428 lines)#7
Merged
Conversation
The guide was 1207 lines — 12 sections covering everything from framework intro through database/JSON/integration patterns and the full Best Practices catalog. Most of that is reference material, not enforceable rules the test-quality / test-writer / test-coverage agents can mechanically check. Per the rule-base architecture: - coding/docs/ holds the rules-only version pr-review consumes - Comprehensive reference (full content) lives in the maintainer's Obsidian Knowledge Base, not surfaced from this plugin This commit: - Trims docs/go-testing-guide.md from 1207 → 428 lines - Keeps: framework brief, critical rules (no stdlib table-tests, no testing.T, no bare error calls), suite setup (standard + main), AAA + lifecycle, suite-timeout MUST, Counterfeiter mock generation, libtime injection MUST, error-testing matcher table, organization + naming conventions, DescribeTable, slices.Contains, compact best practices + anti-patterns - Drops: long database-testing setup, JSON/serialization patterns, full integration test patterns (HTTP server, kafka), running-tests command snippets, CI/CD-integration prose, table-of-contents - Generic examples throughout (User/Order/Product/UnitConverter) — no trading-specific terms - No personal vault path references — plugin stays self-contained for any installer (lesson from PR #6)
There was a problem hiding this comment.
{
"verdict": "approve",
"summary": "The PR successfully trimmed go-testing-guide.md from 1207 to 428 lines (64.6% reduction) while preserving all critical testing rules, suite setup patterns, libtime injection requirements, and Counterfeiter conventions. No personal vault paths or trading-domain terms remain. The file is now a clean rules-only reference.",
"comments": [],
"concerns_addressed": [
"correctness: 3 critical rules preserved (no stdlib table-tests, no testing.T direct use, no bare error calls) - verified",
"correctness: suite setup patterns preserved (standard + main + Compiles test) - verified",
"correctness: libtime injection MUST rule preserved - verified",
"correctness: Counterfeiter directive convention preserved (-o mocks/, --fake-name) - verified",
"tests: no personal vault paths remain - verified clean",
"tests: no trading-domain terms remain (Candle/Epic/Broker/SignalStore/Strategy) - verified clean",
"tests: make precommit passes - Makefile exists with precommit target"
]
}
bborbe
added a commit
that referenced
this pull request
Jun 2, 2026
Same playbook as PR #6 (prometheus) and PR #7 (testing): coding/docs/ holds the enforceable rules-only version that coding:agent-auditor + coding:slash-command-auditor consume; comprehensive reference moves to the maintainer's Obsidian KB. Trimmed 1750 → 347 lines (-80%). Original had: - Extensive prose rationale (Why This Matters expansions) - Multiple duplicate examples per pattern - Long XML-tag taxonomy with detailed semantics - Trading-domain examples (strategy-development-commander, backtest/strategy/, MCP trading tools, '40 Trading/Strategy Documentation Checklist for Commander.md') - Real-world walk-through with named bborbe strategies - Setup-and-configuration deep dives Compact version keeps the enforceable conventions as canonical `### RULE` blocks (Phase 3 ready): - agent-cmd/command-thin (MUST) — commands stay <= 100 lines - agent-cmd/no-user-prompts (MUST) — no /tmp/ writes, no permission prompts during normal execution - agent-cmd/scripts-in-claude-dir (MUST) — scripts pre-created in ~/.claude/scripts/ or skill-local scripts/ - agent-cmd/command-frontmatter (MUST) — description, allowed-tools, argument-hint contract - agent-cmd/agent-frontmatter (MUST) — name, description, tools - agent-cmd/single-source-of-truth (SHOULD) — pin to one canonical data source, drive drift to gaps - agent-cmd/gap-driven-feedback (SHOULD) — agent complains with pointers; feedback loop improves data each run Plus: the Process, Architecture Principles, File Organization, Naming Conventions, XML Tag Patterns table, and a Quality Checklist referencing the rule ids. Generic examples throughout — no trading-specific terms; no personal vault paths (auditors keep working, all references stay inside the plugin package).
This was referenced Jun 2, 2026
3 tasks
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
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
Why
Same architecture as PR #6:
Lessons from PR #6 applied up-front
Test plan