README.md
فایل README.md معرفی‌نامه‌ی پروژه‌ی شماست.
تمام مواردی که یه کاربر بیرونی نیاز داره در مورد پروژه بدونه،
باید تو این فایل آورده بشه یا حداقل به جایی که در موردش توضیح داده شده، اشاره بشه.
پیشنهاد می‌کنم موارد زیر رو حتماً تو این فایل بیارید:
- نام پروژه
- لوگوی شخص، تیم یا شرکت
- لینک به سایت اصلی پروژه
- وضعیت CI/CD، بالا بودن سرورها، پاس شدن تست‌ها و موارد مشابه
- توضیحی کوتاه و چند خطی در مورد کاربرد پروژه
- اهداف پروژه و نیازهایی که می‌تونه برطرف کنه
- پیش‌نیازهای استفاده از پروژه
- لینک دانلود فایل نهایی/اجرایی پروژه
- باگ‌های احتمالی و مواردی که کاربر باید بهشون توجه کنه
- قابلیت‌های فعلی و نحوه‌ی استفاده ازشون
- مستندات کامل یا لینک به جایی که اون‌ها رو قرار دادید
- برنامه‌های آینده و قابلیت‌هایی که می‌خواهید به پروژه اضافه کنید
- شرایط پشتیبانی و نحوه‌ی ثبت درخواست
- توضیح اجمالی، دعوت به مشارکت و لینک به
CONTRIBUTING.md - لینک به صفحات پروژه در شبکه‌های اجتماعی
- معرفی اجمالی توسعه‌دهندگان پروژه و لینک به صفحات مرتبط اون‌ها در شبکه‌های اجتماعی
برای نمونه می‌تونید صفحه‌ی GitHub پروژه‌های بزرگ رو نگاه کنید: