صفحهٔ مخزن روی GitHub اولین چیزی است که همکار یا استخدام‌کننده می‌بیند. README باید در چند خط بگوید پروژه چیست، چطور اجرا می‌شود، و چطور مشارکت کنی.
🎯 اهداف یادگیری
- ریپو را از وب،
ghیا VS Code بسازی - README، Topics، About و visibility را درست بچینی
- تفاوت public، private و internal را بدانی
- فایل‌های اجتماعی مخزن را بشناسی
شکل ۱۳ — Code، About، ستاره، شاخهٔ main و README؛ ویترین پروژه.
🏗️ ساخت ریپو
# 1. وب: New repository — README، gitignore، License # 2. CLI gh repo create git-lab --public --source=. --remote=origin --push # 3. VS Code: Publish to GitHub
تنظیمات حیاتی هنگام ساخت:
- Default branch:
main - Add README: برای مخزن خالی مفید؛ اگر از قبل تاریخچه داری نزن (تعارض)
- gitignore: قالب زبان
- License: برای عمومی، SPDX واضح (MIT، Apache-2.0، یا CC BY-NC-SA مثل راهنماهای فارسی)
📄 README که Senior می‌نویسد
حداقل‌ها:
- یک جمله: پروژه چیست
- نشان‌ها (build, license, version)
- شروع سریع در کمتر از ده فرمان
- لینک اسناد، PDF، دمو
- نحوهٔ مشارکت
از HTML راست‌چین (dir="rtl") برای فارسی نترس — GitHub آن را رندر می‌کند. تصویر hero را در docs/assets بگذار نه ریشه.
🏷️ About، Topics، Social
در سمت راست صفحهٔ ریپو:
- Description یک خطی
- Website (GitHub Pages)
- Topics:
git,github,persian,vscode,guide - Include in home — برای پروفایل
فایل‌های اجتماعی:
| فایل | نقش |
|---|---|
LICENSE |
مجوز |
CODE_OF_CONDUCT.md |
رفتار |
CONTRIBUTING.md |
چگونه PR بفرستند |
SECURITY.md |
گزارش آسیب‌پذیری |
.github/ISSUE_TEMPLATE/ |
قالب باگ/فیچر |
.github/PULL_REQUEST_TEMPLATE.md |
چک‌لیست PR |
CODEOWNERS |
مالک مسیر |
ریپویی با نام دقیقاً برابر username (rezaian-dev/rezaian-dev) روی پروفایل سنجاق می‌شود. ویترین شغلی است.
🔐 Visibility
| نوع | چه کسی می‌بیند | نکتهٔ ۲۰۲۶ |
|---|---|---|
| Public | جهان | Actions رایگان محدود؛ برای نمونه کار عالی |
| Private | تو + همکار دعوت‌شده | Copilot و Rulesets کامل |
| Internal | فقط Enterprise | بین orgهای یک شرکت |
Junior — README اجباری است؟ از نظر Git نه؛ از نظر استخدام بله.
Mid — فرق squash merge در تنظیمات ریپو؟ Settings → General → Pull Requests: اجازهٔ merge commit / squash / rebase. تیم باید یکی را استاندارد کند.
Senior — CODEOWNERS چگونه merge را قفل می‌کند؟ اگر Ruleset «Require review from Code Owners» روشن باشد، تغییر در مسیر بدون Approve مالک نمی‌آید.
✅ چک‌لیست فهم
- ریپو با
ghساخته‌ای - README یک‌جمله‌ای + شروع سریع دارد
- LICENSE و SECURITY وجود دارند
- Topics تنظیم شده
فصل بعد: Fork، clone و رابطه با upstream.