پرش به مطلب اصلی

CONTRIBUTING.md

در دنیای Open-Source، آدم‌های زیادی پیدا می‌شن که به طور رایگان می‌خوان به شما کمک کنن؛ پس باید با فراهم کردن فایل CONTRIBUTING.md مناسب، اون‌ها رو در این راه یاری کنید.

پیشنهاد می‌کنم موارد زیر رو حتماً تو این فایل بیارید:

  • پیشنهاد برای چک کردن لیست Issueهای فعلی و جلوگیری از ثبت Issue تکراری
  • لیست قابلیت‌هایی که دوست دارید توسط دیگران به پروژه اضافه بشن
  • لیست قابلیت‌هایی که دوست ندارید به پروژه اضافه بشن
  • لیست باگ‌هایی که دوست دارید توسط دیگران حل بشن
  • لیست باگ‌هایی که از وجودشون باخبرید اما قصد برطرف کردنشون رو ندارید
  • مراحل ثبت باگ، درخواست امکانات جدید، ارتباط با توسعه‌دهندگان و موارد مشابه
  • پیش‌نیازهای راه‌اندازی پروژه روی سیستم شخص
  • نحوه‌ی Clone کردن و راه‌اندازی پروژه به صورت خط به خط با بیشترین جزئیات ممکن
  • قوانین کدنویسی که تو پروژه رعایت می‌کنید
  • قواعد نوشتن Commit Message

برای نمونه می‌تونید صفحه‌ی GitHub پروژه‌های بزرگ رو نگاه کنید: