توضیح Pull Request برای بازبین با خلاصهٔ تغییرها
قبل از فرستادن PR، یک توضیح درست بنویس که بازبین در دو دقیقه بفهمد چه تغییر کرده، چرا، و کجا باید دقت کند. از روی diff یا فهرست تغییرها، با ساختار ثابت.
- انتشار
- ۲۶ آبان ۱۴۰۵
- اجرا
- ۳ بار
نمونه خروجی
عنوان: Fix duplicate orders when the submit button is double-clicked
چرا: کاربران با دو بار کلیک سریع دو سفارش ثبت میکردند (issue #12). سمت سرور هیچ محافظتی نبود.
چه چیزی تغییر کرد:
- دکمهٔ ثبت بعد از اولین کلیک غیرفعال میشود (OrderForm.tsx)
- سرور یک idempotency key از کلاینت میگیرد و درخواست تکراری را رد میکند (orders.ts)
- مایگریشن برای ستون idempotency_key با unique index
تست: تست واحد برای کلید تکراری؛ دستی با دو کلیک سریع در Chrome.
دقت کنید: مایگریشن روی جدول بزرگ orders است؛ زمان اجرا در production را بررسی کنید.
عمداً نیست: پاکسازی کلیدهای قدیمی؛ در PR بعدی.
چه چیزی لازم داری
diff یا خلاصهٔ تغییرها، و دلیل اصلی تغییر
متن پرامپت
پرامپت فارسیمتنClaudeاین تغییرها را در یک PR میفرستم. دلیل تغییر: [مثلاً رفع باگ شمارهٔ ۱۲ / افزودن قابلیت X].
```
[diff یا فهرست فایلها و تغییرها]
```
توضیح PR را به [فارسی / انگلیسی] با این ساختار بنویس:
- عنوان (حداکثر ۷۰ کاراکتر، با فعل شروع شود)
- چرا: مشکل یا نیاز، در دو جمله
- چه چیزی تغییر کرد: فهرست کوتاه، هر مورد یک خط
- چطور تست شد
- جاهایی که بازبین باید با دقت نگاه کند و چرا
- چیزهایی که عمداً در این PR نیست
بدون تعارف و بدون تکرار diff.بعد از اجرا یا کپی، بگو برایت جواب داد یا نه.
چطور اجرا کنم
- دکمهٔ اجرا را بزن تا پرامپت در jostoju باز شود، یا متن را کپی کن و در ابزار دلخواهت بگذار.
- diff یا خلاصهٔ تغییرها، و دلیل اصلی تغییر را به آن بده.
- جایخالیهای داخل [ ] را با اطلاعات خودت پر کن.
- اگر نتیجه دقیقاً آن چیزی نبود که میخواستی، یک جمله توضیح اضافه کن و دوباره اجرا کن.
پرامپت فارسی؛ مدلها پرامپت انگلیسی را هم با ورودی فارسی خوب میفهمند. کلمهای ناآشنا بود؟ واژهنامه.