code-review

作者： sentry

遵循Sentry工程實踐的程式碼審查框架，用於拉取請求與程式碼品質評估。涵蓋六大關鍵問題領域：執行時期錯誤、效能瓶頸、副作用、向後相容性、ORM查詢問題及安全漏洞。包含針對元件互動、架構一致性與需求衝突的設計評估指引。要求涵蓋功能測試、整合測試與端到端測試的適當測試覆蓋率，並驗證邊界...

npx skills add https://github.com/getsentry/skills --skill code-review

下載 ZIP GitHub

898

Sentry Code Review

Follow these guidelines when reviewing code for Sentry projects.

Review Checklist

Identifying Problems

Look for these issues in code changes:

Runtime errors: Potential exceptions, null pointer issues, out-of-bounds access
Performance: Unbounded O(n²) operations, N+1 queries, unnecessary allocations
Side effects: Unintended behavioral changes affecting other components
Backwards compatibility: Breaking API changes without migration path
ORM queries: Complex Django ORM with unexpected query performance
Security vulnerabilities: Injection, XSS, access control gaps, secrets exposure

Design Assessment

Do component interactions make logical sense?
Does the change align with existing project architecture?
Are there conflicts with current requirements or goals?

Test Coverage

Every PR should have appropriate test coverage:

Functional tests for business logic
Integration tests for component interactions
End-to-end tests for critical user paths

Verify tests cover actual requirements and edge cases. Avoid excessive branching or looping in test code.

Long-Term Impact

Flag for senior engineer review when changes involve:

Database schema modifications
API contract changes
New framework or library adoption
Performance-critical code paths
Security-sensitive functionality

Feedback Guidelines

Tone

Be polite and empathetic
Provide actionable suggestions, not vague criticism
Phrase as questions when uncertain: "Have you considered...?"

Approval

Approve when only minor issues remain
Don't block PRs for stylistic preferences
Remember: the goal is risk reduction, not perfect code

Common Patterns to Flag

Python/Django

# Bad: N+1 query
for user in users:
    print(user.profile.name)  # Separate query per user

# Good: Prefetch related
users = User.objects.prefetch_related('profile')

TypeScript/React

// Bad: Missing dependency in useEffect
useEffect(() => {
  fetchData(userId);
}, []);  // userId not in deps

// Good: Include all dependencies
useEffect(() => {
  fetchData(userId);
}, [userId]);

Security

# Bad: SQL injection risk
cursor.execute(f"SELECT * FROM users WHERE id = {user_id}")

# Good: Parameterized query
cursor.execute("SELECT * FROM users WHERE id = %s", [user_id])