Back to Skiasharp

Add / Review API Skill

.agents/skills/api-add-review/SKILL.md

4.148.02.8 KB
Original Source

Add / Review API Skill

This skill has two modes:

  1. Add mode — implement a new API from scratch, then review it
  2. Review mode — review an existing PR/diff for API design correctness

Both modes share the same design rules and quality bar.

Detecting Mode

User saysMode
"add", "expose", "wrap", "create binding"Add
"review", "check API", "look at PR"Review
Issue classified as "New API"Add
Self-review after addingReview (automatic)

⚠️ Branch Protection (COMPLIANCE REQUIRED)

🛑 NEVER commit directly to protected branches. This is a policy violation.

RepositoryProtected BranchesRequired Action
SkiaSharp (parent)mainCreate feature branch first
externals/skia (submodule)main, skiasharpCreate feature branch first

❌ NEVER Do These

ShortcutConsequence
Commit directly to main or skiasharpPolicy violation
Edit *.generated.cs manuallyOverwritten on regenerate
Skip native build after C API changeEntryPointNotFoundException
Skip testsUnacceptable
Skip tests because they failUnacceptable — fix the issue
Use default parameters in public APIsABI breaking change
Invent type names not in upstream SkiaConfusing, wrong naming
Add XML doc commentsInserted by separate process
Fabricate test fontsUse real fonts from known sources

References

All three references work together:

FilePurposeWhen to read
references/api-design-rules.mdNaming, properties vs methods, Span patterns, type wrapping, test and sample requirementsAlways — before writing or reviewing any API
references/add-workflow.mdStep-by-step add workflow with C API patterns, struct conversion, JSON config, gallery samplesAdd mode
references/review-workflow.mdStructured review checklist, test coverage analysis, sample review, auto-fix modeReview mode, and as final phase of add mode
references/troubleshooting.mdCommon errors and fixesWhen something goes wrong

Add Mode

  1. Read api-design-rules.md
  2. Follow add-workflow.md phases 1-10
  3. Run review-workflow.md on your own changes
  4. Fix any issues identified by the review
  5. Re-run tests to confirm

Review Mode

  1. Read api-design-rules.md
  2. Follow review-workflow.md
  3. In fix-first mode: auto-fix high-confidence issues, re-run tests
  4. In review-only mode: produce structured feedback report