docs: Add agent implementation guidelines from PR #519 lessons#524
Merged
docs: Add agent implementation guidelines from PR #519 lessons#524
Conversation
Three new rules in Critical Conventions based on mistakes made during the orphaned worker diagnostic implementation (#519 vs #521): 1. Explore Before Implementing — grep for existing patterns before designing. Would have found MultiAgentRole enum instead of using fragile string matching. 2. No New Companion-Pair State Fields — derive state from existing data instead of adding new fields that must be maintained across N code paths. The 13-PR IsProcessing regression history proves this is the #1 bug source. 3. Behavioral Tests Over Structural Tests — inject real objects and verify outputs, not grep source for string patterns. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Owner
Author
|
CI status: Prior review comments:
FindingsNo remaining issues after re-review. All 3 reviewers agreed the earlier concern is resolved, and the new guidance is now accurate, actionable, and consistent with the repository’s existing conventions. Test coverageThis is a docs-only PR, so there are no new runtime code paths to test. Recommendation✅ Approve — ready to merge. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Three new rules in Critical Conventions learned from the #519 vs #521 comparison:
These would have prevented the design mistakes in #519 (fragile string matching instead of
MultiAgentRoleenum, newLastSynthesisCompletedAtfield instead of timestamp comparison, structural grep tests instead of behavioral).