Skip to content

chore(codereview): document external API validation + require official doc links#17

Draft
xingyaoww wants to merge 2 commits intomainfrom
chore/codereview-skill-docs-external-api
Draft

chore(codereview): document external API validation + require official doc links#17
xingyaoww wants to merge 2 commits intomainfrom
chore/codereview-skill-docs-external-api

Conversation

@xingyaoww
Copy link
Contributor

What

Adds an explicit section to both codereview and codereview-roasted skills instructing reviewers to:

  • validate changes that add/modify external API access (auth/scopes, endpoints/methods/headers, pagination/rate limits, retries/timeouts, error handling)
  • ensure secrets/PII are handled safely
  • ensure required configuration is documented
  • include validated official documentation URL(s) when applicable

Why

To reduce review misses for integrations with external services and keep reviews grounded in authoritative documentation.

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