‫ارتقاء کیفیت پیام‌های Commit با استفاده از هوش مصنوعی GitHub Copilot

# ✅ GitHub Copilot: دستورالعمل‌های پیام Commit

یک پیام Commit واضح و توصیفی **فقط بر اساس تغییرات ارائه شده** بنویسید. از این **قوانین سختگیرانه قالب‌بندی و محتوا** پیروی کنید.

---

## 🧠 قوانین کلی

- بر **بیان هدف** تغییر تمرکز کنید، نه آنچه تغییر کرده است.
- در بدنه پیام از **زمان گذشته** استفاده کنید.
- در خلاصه (Summary) از **وجه امری** استفاده کنید (مثلاً: "رفع اشکال ورود").
- اگر یک فایل **تغییر نام داده یا منتقل شده است**، فقط آن را ذکر کنید و جزئیات دیگر را نادیده بگیرید.

---

## 📦 قالب پیام Commit

### **خط خلاصه** (حداکثر 50 کاراکتر)

- با **gitmoji** صحیح شروع کنید.
- یک **خلاصه مختصر** به **وجه امری** بنویسید (مثلاً: ✨ افزودن دکمه ورود).
- از **بیش از 50 کاراکتر** استفاده نکنید.

### **بدنه** (اختیاری اما توصیه می‌شود، 72 کاراکتر در هر خط)

- خلاصه را با **یک خط خالی** از بدنه جدا کنید.
- بر **چرایی** تغییر تمرکز کنید.
- برای خوانایی از **نقاط گلوله‌ای** استفاده کنید.
- از جزئیاتی که در Git diff قابل مشاهده است، اجتناب کنید.
- می‌توانید هر چقدر که نیاز است بنویسید، اما **در 72 کاراکتر در هر خط متن را بشکنید**.
- از **اصطلاحات مبهم** مانند _به‌روزرسانی_، _بهبود_ یا _بهتر_ استفاده نکنید.

> ✅ **طول کل پیام نباید از 500 کاراکتر تجاوز کند**

---

## 🧑‍🤝‍🧑 نویسندگان

این بخش در پایین پیام الزامی است:

Author: {{git config user.name}} Co-Author: Copilot

---

## 🔍 آگاهی از زمینه

- در صورت لزوم، برای درک هدف تغییر، **کل راه حل (Solution)** را تحلیل کنید.

---

## 🚀 استفاده از Gitmoji

| Gitmoji | معنی                          |
|--------:|----------------------------------|
| 🚧     | در حال انجام                   |
| ⚡️     | بهبود عملکرد                  |
| 🐛     | رفع یک اشکال                   |
| ✨     | معرفی یک ویژگی جدید          |
| 📝     | افزودن یا به‌روزرسانی مستندات |
| ✅     | افزودن، به‌روزرسانی یا گذراندن تست‌ها |
| 🔒️     | رفع مسائل امنیتی              |
| ♻️     | بازسازی کد                    |
| ✏️     | تغییر نام یا انتقال فایل‌ها     |

---

کامیت‌های موفقی داشته باشید! 🧠✍️

• پس از اعمال تغییرات کد، آن‌ها را با Git مرحله‌بندی (Stage) کنید:

git add .

• پنل گفتگوی Copilot (Copilot Chat) را در VS Code باز کنید (معمولاً با Ctrl+Shift+I یا از طریق آیکون Copilot).
• با کپی کردن الگوی راهنما و افزودن دستورالعمل‌ها، از Copilot بخواهید یک پیام Commit تولید کند:

بر اساس تغییراتی که برای Commit مرحله‌بندی کرده‌ام، یک پیام Commit مطابق با این دستورالعمل‌ها تولید کنید:

{محتوای فایل commit-messages.md را در اینجا جایگذاری کنید}

• یک فایل اسکریپت (مثلاً copilot-commit.sh) با محتوای زیر ایجاد کنید:

#!/bin/bash

# دریافت تفاوت (diff) تغییرات مرحله‌بندی شده
DIFF=$(git diff --cached)

# مسیر فایل الگوی پیام Commit
TEMPLATE_PATH="./commit-messages.md"

# خواندن الگو
TEMPLATE=$(cat $TEMPLATE_PATH)

# استفاده از VS Code Copilot CLI یا روش دیگر برای ارسال درخواست و دریافت پاسخ
# این یک مثال ساده است - پیاده‌سازی بر اساس تنظیمات شما متفاوت خواهد بود
COMMIT_MSG=$(echo -e "بر اساس این تغییرات:\n$DIFF\n\nیک پیام Commit مطابق با این دستورالعمل‌ها تولید کنید:\n$TEMPLATE" | copilot-cli)

# استفاده از پیام تولید شده برای Commit
git commit -m "$COMMIT_MSG"

• اسکریپت را قابل اجرا کنید:

chmod +x copilot-commit.sh

• یک نام مستعار (Alias) Git برای استفاده آسان‌تر اضافه کنید:

git config --global alias.ai-commit '!path/to/copilot-commit.sh'

• اکنون می‌توانید از دستور جدید خود استفاده کنید:

git add .
git ai-commit

• افزودن دسته‌بندی‌های gitmoji خاص پروژه.
• شامل کردن ارجاعات به شماره‌های تیکت (Ticket) یا سیستم‌های پیگیریIssue Tracking)).
• تنظیم محدودیت‌های کاراکتر بر اساس ترجیحات تیم.
• افزودن اصطلاحات یا قراردادهای خاص دامنه.

• بررسی کنید که gitmoji به درستی نوع تغییر را نشان می‌دهد.
• تأیید کنید که خلاصه به طور دقیق هدف تغییرات شما را بیان می‌کند.
• اطمینان حاصل کنید که بدنه پیام زمینه کافی را بدون زیاده‌گویی فراهم می‌کند.
• در صورت نیاز، برای مطابقت با دستورالعمل‌های خاص تیم خود، آن را ویرایش کنید.

// قبل
public async Task<User> GetUserById(int id)
{
    return await _context.Users.FindAsync(id);
}

// بعد
public async Task<User> GetUserById(int id)
{
    var user = await _context.Users.FindAsync(id);
    if (user == null)
    {
        throw new NotFoundException($"User with ID {id} not found");
    }
    return user;
}

🐛 افزودن بررسی null در متد GetUserById

- اعتبارسنجی اضافه شد تا در صورت پیدا نشدن کاربر، به جای بازگرداندن null، یک NotFoundException مناسب پرتاب شود.
- این کار از NullReferenceException در کد پایین‌دستی که انتظار یک شیء کاربر معتبر را دارد، جلوگیری می‌کند.
- با ارائه یک پیام خطای توصیفی‌تر با شناسه کاربری خاص، مدیریت خطا بهبود می‌یابد.

Author: fingers10 Co-Author: Copilot