Skip to content

Commit 4d7638c

Browse files
ryansolidClaude via Cursor
andcommitted
chore(rules): public API changes must be flagged before they are made
Any new/removed export, prop, option, parameter, diagnostic code, or changed signature/default/documented behavior is called out to the maintainer as its own item before it is made or committed — including parity/symmetry changes and subagent briefs — and listed under its own heading in the PR body. Co-authored-by: Claude via Cursor <[email protected]>
1 parent a124577 commit 4d7638c

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎.cursor/rules/engineering-standards.mdc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Commits and pushes always require an explicit ask in the user's latest message.
2222
- **Understand before implementing.** If a design or proposal isn't fully clear, ask questions first. Don't start coding until the model is understood.
2323
- **Correctness over speed.** Take the time to get it right. A wrong implementation that passes tests is worse than no implementation.
2424

25+
## Public API changes must be flagged
26+
27+
Any change to the public surface — a new or removed export, prop, option, or parameter; a changed signature, default, or documented behavior of an existing one; a new diagnostic code — must be called out explicitly to the maintainer *before* it is made (or, when discovered mid-task, before it is committed), stated as its own item, not folded into a summary of the fix. This applies to changes made for "parity", "symmetry", or "while I was there" exactly as much as to changes the task asked for; those are the ones most likely to slip through. The same applies to instructions given to subagents: a brief that would add or remove public surface must say so, and the agent must report the surface it touched. The PR body must list every public API change under its own heading.
28+
2529
## When Comparing Approaches
2630

2731
- Each approach must be architecturally distinct, not a rename of the other.

0 commit comments

Comments
 (0)