Skip to content

feat(skills): add precompile design skills - #256

Merged
rayyan224 merged 1 commit into
mainfrom
rayyanalam/precompile-design-skills
Oct 23, 2026
Merged

rayyan224 merged 1 commit into
mainfrom
rayyanalam/precompile-design-skills

Conversation

@rayyan224

Copy link
Copy Markdown
Collaborator

Summary

Adds four agent skills that take a precompile change from its motivation to a point-form ADR, and retires the skills they replace.

Skill What it does
motivation-check Checks a change's Motivation, user flows and must-not-break items before design starts; flags gaps, solution hints and uncheckable items.
design-plan One designer pass from a given perspective: reads the motivation and the code, writes a plan in the bundled plan template (readable part first: approach, Solidity interface, behaviour changes as steps, flows, trade-offs; reference part last), and self-lints with the bundled linter until clean.
design-council Runs several independent design-plan passes (a minimal-change reference point plus distinct perspectives), presents the candidates side by side and selects the main plan by how well it serves the user flows.
adr-writer Writes the ADR from the motivation and the chosen plan: Summary, Motivation, Background, Specs (interface as code, behaviour per change), Examples, Design Decisions and Alternatives, Migration Steps for integrators.

Removed: changelog-grill, changelog-gap-check and technical-document. adr-writer keeps the technical-document style references (Google technical writing, simplified technical English, point-form template).

Notes

  • Replaces the stacked draft PRs chore(skills): retire the legacy changelog skills #244 to feat(skills): remove legacy technical-document skill #255, which built the same skills step by step.
  • design-plan/references/ bundles a plan template, a standalone linter (lint.py with plan_inputs.py) and a short invariants file; the linter runs with plain python3.
  • Two bundled reference files still mention an evaluation context in passing (global-invariants.md and a comment in lint.py); they will be reworded before this leaves draft.
  • Draft until the skill text has been reviewed.

How to verify

python3 -B .claude/skills/design-plan/references/lint.py --help

Adds motivation-check, design-plan, design-council and adr-writer, which take a change motivation through independent design plans to a point-form ADR. Retires changelog-grill, changelog-gap-check and technical-document; adr-writer keeps the technical-document style references.
@github-actions

Copy link
Copy Markdown

Interface Coverage

✅ All interface functions have test coverage.

Comment thread .claude/skills/design-plan/references/lint.py Dismissed
@github-actions

Copy link
Copy Markdown

📊 Forge Coverage (src/lib/)

🟡 ≥95% across all metrics — some metrics below 99%.

File Lines Stmts Branches Funcs
🟡 B20FactoryLib.sol 97.70% 98.00% 100.00% 95.00%
🔴 test/lib/ForceFeeder.sol 0.00% 0.00% 100.00% 0.00%
🔴 test/lib/PrecompileProbe.sol 0.00% 0.00% 0.00% 0.00%
🟢 MockActivationRegistry.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockActivationRegistryStorage.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockB20.sol 100.00% 99.68% 100.00% 100.00%
🟢 MockB20Asset.sol 100.00% 100.00% 100.00% 100.00%
🟡 MockB20Factory.sol 98.96% 99.10% 100.00% 100.00%
🟢 MockB20Stablecoin.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockB20Storage.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockBaseTime.sol 100.00% 100.00% 100.00% 100.00%
🟡 MockPolicyRegistry.sol 100.00% 99.58% 97.78% 100.00%
🟢 MockPolicyRegistryStorage.sol 100.00% 100.00% 100.00% 100.00%
Total 97.14% 97.51% 98.21% 97.07%

Full report: download artifact. To browse locally: make coverage (runs forge coverage + genhtml + opens the HTML report).

@github-actions

Copy link
Copy Markdown

✅ Fork tests: 794 passed, 0 failed, 14 skipped

The completed Denim suite passed. Skipped tests were not validated.

@rayyan224
rayyan224 marked this pull request as ready for review October 23, 2026 20:37
@rayyan224
rayyan224 merged commit da109a7 into main Oct 23, 2026
10 checks passed
@rayyan224
rayyan224 deleted the rayyanalam/precompile-design-skills branch October 23, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants