Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
xingyaoww wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0b87b7
chore(codereview): add external API + official-doc validation section
openhands-agent Jan 14, 2026
ca19078
chore(codereview-roasted): ask reviewers to include official doc URLs
openhands-agent Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions skills/codereview-roasted/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ Focus on real security risks, not theoretical ones:
- Memory safety issues in unsafe languages
- Concurrency bugs that cause data corruption

6. **External APIs & Documentation Validation**
If the change touches external services (GitHub/GitLab/Bitbucket/Datadog/Slack/etc.), be paranoid and verify:
- auth method and required scopes/permissions
- endpoint/method/headers correctness
- pagination, rate limits, retries/timeouts, and error handling
- no secrets/PII are exposed (especially logs)
- required configuration is documented

If applicable, include validated official documentation URL(s) that confirm referenced flags/config keys/endpoints/behavior.

CRITICAL REVIEW OUTPUT FORMAT:

Start with a **Taste Rating**:
Expand Down
10 changes: 10 additions & 0 deletions skills/codereview/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,19 @@ Watch for:
- Incorrect use of cryptographic libraries
- Common pitfalls (null dereferencing, off-by-one errors, race conditions)

4. External APIs & Documentation Validation
Check for:
- Any new or changed access to external APIs (GitHub/GitLab/Bitbucket/Datadog/Slack/etc.)
- Correct API usage (auth method/scopes/permissions, endpoint+method, required headers, pagination/rate limits)
- Robustness (retries/timeouts, error handling)
- Security hygiene (no secrets/PII leaked to logs)
- Required configuration is properly documented (env vars, tokens, permissions)

INSTRUCTIONS FOR RESPONSE:
Group the feedback by the scenarios above.

If applicable, include validated official documentation URL(s) that confirm referenced flags/config keys/endpoints/behavior.

Then, for each issue you find:
- Provide a line number or line range
- Briefly explain why it's an issue
Expand Down