Skip to content
← العودة إلى الكتالوج
جودة الشيفرةمتوسطcommunity

comprehensive-review-pr-enhance

أنشئ وصفات طلبات سحب منظمة من الفروقات، وأضف قوائم مراجعة، وتقييمات المخاطر، وملخصات تغطية الاختبار. استخدم عندما يقول المستخدم "اكتب وصف طلب سحب"، "حسّن هذا الطلب"، "ملخص تغييراتي"، "مراجعة طلب السحب"، أو يطلب توثيق فرق للمراجعين.

محتوى هذه المهارة بلغته الأصلية (غالبًا الإنجليزية).

Pull Request Enhancement

When to Use

  • You need to turn a git diff into a reviewer-friendly pull request description.
  • You want a PR summary with change categories, risks, testing notes, and a checklist.
  • The diff is large enough that reviewers need explicit structure instead of a short ad hoc summary.

Workflow

  1. Run git diff <base>...HEAD --stat to identify changed files and scope
  2. Categorise changes: source, test, config, docs, build, styles
  3. Generate the PR description using the template below
  4. Add a review checklist based on which file categories changed
  5. Flag breaking changes, security-sensitive files, or large diffs (>500 lines)

PR Description Template

## Summary
<!-- one-paragraph executive summary: what changed and why -->

## Changes
| Category | Files | Key change |
|----------|-------|------------|
| source   | `src/auth.ts` | added OAuth2 PKCE flow |
| test     | `tests/auth.test.ts` | covers token refresh edge case |
| config   | `.env.example` | new `OAUTH_CLIENT_ID` var |

## Why
<!-- link to issue/ticket + one sentence on motivation -->

## Testing
- [ ] unit tests pass (`npm test`)
- [ ] manual smoke test on staging
- [ ] no coverage regression

## Risks & Rollback
- **Breaking?** yes / no
- **Rollback**: revert this commit; no migration needed
- **Risk level**: low / medium / high — because ___

Review Checklist Rules

Add checklist sections only when the matching file category appears in the diff:

File categoryChecklist items
sourceno debug statements, functions <50 lines, descriptive names, error handling
testmeaningful assertions, edge cases, no flaky tests, AAA pattern
configno hardcoded secrets, env vars documented, backwards compatible
docsaccurate, examples included, changelog updated
security-sensitive (auth, crypto, token, password in path)input validation, no secrets in logs, authz correct

Splitting Large PRs

When diff exceeds 20 files or 1000 lines, suggest splitting by feature area:

git checkout -b feature/part-1
git cherry-pick <commits-for-part-1>

Resources

  • resources/implementation-playbook.md — Python helpers for automated PR analysis, coverage reports, and risk scoring

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
— Field Manual

الـ 1٬441 مهارة، مُبسَّطة في PDF واحد.

دليل تحريري مجاني كتبناه لـ Skills Atlas: التصنيف، الـ 25 مهارة الأساسية، الأنماط المضادة، مسارات التعلّم حسب الملف الشخصي.

  • أكثر من 70 صفحة، جدول محتويات، جاهز للطباعة.
  • يُرسل بالبريد — الرابط صالح 7 أيام.
  • يمكنك إلغاء الاشتراك بضغطة واحدة في أي وقت.

لا spam. لا نشارك بريدك. إلغاء بضغطة واحدة.