Repository navigation
chore: sync agent standards: key code interfaces with end-to-end usage, example-first issues, interface and efficiency review - #714
Merged
Conversation
Brings ProjectASAP/agent-standards#9 into this repository: the asap-pr-authoring skill, the pull-request template and AGENTS.md now ask every PR description for a Key code interfaces added / modified section.
File-grouped declaration blocks with links at a fixed commit and a usage snippet, following PR #537 (ProjectASAP/agent-standards#9).
…ions from agent-standards
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.
Why
Reviewers need to see a change's API impact without reading the whole diff. PR descriptions currently explain why, what, and how, but they don't list which public interfaces were added, changed, or removed.
What
Every ASAPPlanner pull-request description gains a Key code interfaces added / modified section, placed right after How.
How
skills/asap-pr-authoring/SKILL.md: a new step 4 that says what to list (types, functions, methods, traits, fields, enum variants, module paths, CLI flags, wire/file/document formats) and how (a short signature excerpt with its crate or module path, copied from the diff, plus one line on what changed). It is "None" when nothing changes. Later steps are renumbered.templates/github/PULL_REQUEST_TEMPLATE/projectasap.md: the matching section after How.AGENTS.md: the policy bullet on PR descriptions names the section.Also synced (later commits): the interfaces-section layout (#537 style with per-item explanations), the new
asap-issue-authoringskill (issues start from a concrete example of the problem), and an## Examplesection in every issue template.Also synced (latest commit), two rules for the interfaces section that came out of the #715 review:
///and a// unchanged/// new/// was X/// removedmarker, never// .... The type itself gets a///saying whether it stays or is removed.references/key-code-interfaces-example.mdis now a verified excerpt from #715 that follows both rules.Code review (
asap-code-review) gains a required step, following a user request: for the interfaces in the PR, the reviewer asks whether they can be simpler or easier for a human to read, and gives the author choices. The checklist covers:The findings go in an "Interface simplifications (author's choice)" section. Each option gives the current signature, the proposed one and the trade-off, and the author picks.
A second required review dimension is Efficiency: the performance complexity of the new code paths. The reviewer checks:
Each finding gives the complexity, an input size where it hurts, and a cheaper alternative, with choices when there is a trade-off. The review output has three sections: Findings, "Interface simplifications (author's choice)", and "Efficiency". The skill has worked examples from #712, #707 and #717.
Key code interfaces added / modified
None (documentation and templates only).
Before this PR
PR descriptions had no dedicated place for interface changes, so reviewers had to find them in the diff.
After this PR
Every PR description lists its public interface changes, or "None". This repository now carries the updated skill, template and policy (synced from ProjectASAP/agent-standards#9).
Verification
Documentation-only change. The rendered Markdown of every changed file was reviewed. The key-code-interfaces example's Usage was run at ASAPPlanner #715's merge commit (
1b5d9577), and its numbers come from that run.Limitations and follow-up
If agent-standards#9 changes during its review, re-sync the changed files.