Files
paya-university-fault-system/CONTRIBUTING.md
T
amir e2df09ec3a Add contributing guidelines in Persian (#1)
Added a comprehensive guide for contributing to the project, including steps for cloning the repository, creating a personal branch, committing changes, pushing to GitHub, and creating pull requests.
2026-10-26 21:59:44 +03:30

91 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# راهنمای کوتاه همکاری روی گیت‌هاب
مخزن پروژه:
https://github.com/AmirAref/paya-university-fault-system
چون چند نفری روی پروژه کار می‌کنیم، **هیچ‌کس نباید مستقیم روی برنچ `main` کار کند**.
هر نفر یک برنچ شخصی می‌سازد و فقط روی همان کار می‌کند.
## ۱. کلون کردن مخزن (فقط یک‌بار)
```bash
git clone https://github.com/AmirAref/paya-university-fault-system.git
cd paya-university-fault-system
```
---
## ۲. ساخت برنچ شخصی
نام برنچ را این‌طور بگذارید (مثال):
```bash
git checkout -b aref-tasks
```
پیشنهاد نام‌گذاری:
- `aref-tasks`
- `arshia-tasks`
- `reza-tasks`
یا هر نامی که مشخص کند مال شماست.
---
## ۳. کار کردن و ذخیره تغییرات
بعد از هر تغییر مهم:
```bash
git status # ببین چه فایل‌هایی تغییر کرده‌اند
git add . # همه تغییرات را اضافه کن
git commit -m "توضیح کوتاه کار انجام‌شده"
```
مثال پیام کامیت خوب:
- `"افزودن بخش بازیگران به use-case.md"`
- `"اصلاح توضیحات نیازمندی‌های عملکردی"`
---
## ۴. ارسال برنچ به گیت‌هاب
```bash
git push -u origin aref-tasks
```
(فقط بار اول `-u` لازم است. دفعات بعدی فقط `git push` کافی است.)
---
## ۵. ساخت Pull Request (پیشنهاد ادغام)
1. برو به صفحه مخزن روی گیت‌هاب
2. روی دکمه **Compare & pull request** کلیک کن
3. عنوان و توضیح کوتاه بنویس
4. Create pull request را بزن
یکی از اعضا (ترجیحاً بازبین همان بخش) PR را بررسی و در صورت تأیید Merge می‌کند.
---
## نکات مهم
- همیشه قبل از شروع کار جدید، آخرین تغییرات `CONTRIBUTINGmain` را بگیر:
```bash
git checkout main
git pull
git checkout aref-tasks
git merge main
```
- پیام کامیت را واضح و کوتاه بنویس.
- فقط روی برنچ خودت کار کن.
- اگر گیج شدی یا ارور گرفتی، از بقیه بپرس؛ نگذار مشکل بزرگ شود.
---
اگر مرحله‌ای را متوجه نشدید، تو گروه‌مون بپرسید تا سریع حلش کنیم.