چک لیست مشارکت در مستندات

مراحل اولیه

1. ساخت اکانت گیت‌هاب و ارسال آیدی گیت‌هاب به مسئول دسترسی

   • به وب‌سایت GitHub بروید.
   • برای ایجاد یک حساب کاربری جدید، روی Sign Up کلیک کنید و مراحل ثبت‌نام را طی کنید.
   • آیدی گیت‌هاب خود را به شخصی که مسئول اعطای دسترسی است ارسال کنید.

2. دریافت دسترسی به مخزن کد (ریپو)

   • لطفاً درخواست دسترسی به مخزن کد را ارسال کنید.

3. آشنایی با گیت (در صورت نیاز)

   • در صورتی که با گیت آشنا نیستید، لطفاً آموزش گیت را از لینک زیر مطالعه کنید: آموزش گیت

4. نصب Visual Studio Code

   • به وب‌سایت Visual Studio Code بروید.
   • نسخه مناسب سیستم‌عامل خود را دانلود کنید.
   • فایل دانلود شده را اجرا کرده و دستورالعمل‌های نصب را دنبال کنید.

5. نصب گیت

   • به وب‌سایت Git بروید.
   • نسخه مناسب سیستم‌عامل خود را دانلود کنید.
   • فایل دانلود شده را اجرا کرده و دستورالعمل‌های نصب را دنبال کنید.

6. نصب Node.js و npm

   • به وب‌سایت Node.js بروید.
   • نسخه مناسب سیستم‌عامل خود را دانلود و نصب کنید. npm به همراه Node.js نصب می‌شود.

7. کلون کردن مخزن کد

   • Visual Studio Code را باز کنید.
   • از منوی اصلی، گزینه View و سپس Command Palette را انتخاب کنید.
   • در Command Palette، عبارت Git: Clone را تایپ کنید و گزینه مربوطه را انتخاب کنید.
   • URL مخزن را وارد کرده و محل ذخیره را انتخاب کنید:

     https://github.com/Mohaymen-ICT/star-docs

8. باز کردن پوشه پروژه

   • از منوی اصلی، گزینه File و سپس Open Folder را انتخاب کنید.
   • پوشه star-docs را که کلون کرده‌اید باز کنید.

9. نصب بسته‌های مورد نیاز

   • در Visual Studio Code، از منوی اصلی، گزینه Terminal و سپس New Terminal را انتخاب کنید.
   • در ترمینال باز شده، دستور زیر را وارد کنید:

     npm install

10. اجرای پروژه

    • در همان ترمینال، دستور زیر را برای اجرای پروژه وارد کنید:

      npm run start
      بعد از اجرای این دستور روی ماشین شخصی امکانی فراهم می‌شود که خروجی مورد انتظار را روی پورت 3000 ببینید. باید در مرورگر آدرس زیر را وارد کنید. لینک مستندات لوکال

ویرایش مستندات

11. آشنایی با ویژگی‌های مارک داون در Docusaurus

    • لطفاً مستندات مربوط به ویژگی‌های مارک داون در Docusaurus را از لینک زیر مطالعه کنید: ویژگی‌های مارک داون در Docusaurus

12. تغییر مسیر به پوشه مستندات مورد نظر

    • در Visual Studio Code، در بخش Explorer، به پوشه star-docs بروید و آن را باز کنید.

13. ساخت یک شاخه (برنچ) جدید با نام مناسب

    • در Visual Studio Code، از منوی اصلی، گزینه Source Control (یا آیکون گیت در نوار کناری) را انتخاب کنید.
    • روی سه نقطه بالای بخش Source Control کلیک کنید و گزینه Create Branch را انتخاب کنید.
    • یک نام مناسب برای شاخه جدید وارد کنید.

14. اعمال تغییرات مورد نظر

    • تغییرات مورد نظر خود را در فایل‌های مستندات اعمال کنید و آن‌ها را ذخیره نمایید.
    • می‌توانید از بخش preview خروجی markdown نوشته شده را بررسی کنید.

ساخت درخواست مرج (Pull Request)

15. ایجاد درخواست مرج (Pull Request)
    • پس از اعمال تغییرات، به بخش Source Control بروید.
    • تغییرات را اضافه کنید و یک پیام تعهد (commit message) وارد کنید و سپس تغییرات را تعهد دهید.
    • روی سه نقطه بالای بخش Source Control کلیک کنید و گزینه Push to را انتخاب کنید تا تغییرات به مخزن آنلاین ارسال شود.
    • به صفحه مخزن GitHub بروید و یک درخواست مرج (Pull Request) ایجاد کنید و آن را برای بررسی ارسال نمایید.

اعمال تغییرات پیشنهادی و مرج نهایی

16. اعمال تغییرات پیشنهادی توسط مسئولان مخزن

    • نظرات و پیشنهادات مسئولان مخزن را بازبینی کرده و تغییرات لازم را اعمال کنید.

17. مرج کردن و بررسی نهایی در دیپلوی شدن اتوماتیک

    • پس از تایید درخواست مرج توسط مسئولان، شاخه مورد نظر را مرج کنید و از دیپلوی شدن اتوماتیک پروژه اطمینان حاصل نمایید.

این چک لیست به شما کمک می‌کند تا به صورت منظم و دقیق در مستندات مشارکت کنید.