Teach Agora agents to document public contract changes - #1664
Open
kelos-bot[bot] wants to merge 1 commit into
Open
Teach Agora agents to document public contract changes#1664kelos-bot[bot] wants to merge 1 commit into
kelos-bot[bot] wants to merge 1 commit into
Conversation
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.
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
Adds one shared Agora agent instruction requiring matching README, example, or skill documentation whenever an implementation changes a public contract.
This is motivated by Agora PR #7, where a generated implementation changed the required
AGORA_URLbehavior but initially omitted the corresponding README andskills/agora-reportingupdates. The review finding identified the missing public-contract documentation as P2, and the responder follow-up confirmed that both documentation surfaces needed updates.The August 12–19 review window contained no Agora PRs, so the audit also covered the repository's full recent set (#1, #2, #3, #6, and #7). Only #7 had substantive review feedback, and no other configuration rules were added.
Which issue(s) this PR is related to:
N/A
Special notes for your reviewer:
The shared rule lives in
self-development/agora/agentconfig.yamlso all Agora implementation agents receive it. Existing planner and reviewer prompts already check documentation completeness; this closes the corresponding gap in the shared implementation behavior without duplicating skills.Validation:
make verifyDoes this PR introduce a user-facing change?
Summary by cubic
Adds a shared rule that requires documentation updates in the same PR when an Agora public contract changes. Previously, contract changes could land without synchronized docs; now agents must update the matching
README.md,examples/, orskills/docs to prevent drift.Review and rollout
self-development/agora/agentconfig.yaml; applies to all Agora implementation agents.skills/agora-reportingcontract.make verify.Written for commit db7d5b6. Summary will update on new commits.