دستورالعمل ایجاد پروژه آزاد/متن‌باز

بسم الله الرحمن الرحیم

این دستورالعمل از سری دستورالعمل‌هایی هستش که در بنیاد مردمی پایادل استفاده میشه و ممکنه در آینده به روز رسانی بشه.

برای ایجاد پروژه آزاد/متن‌باز، کارهایی که باید انجام بدیم به صورت زیر هستش:

• مشخص کنیم چرا می‌خوایم پروژه رو به صورت آزاد/متن‌باز ارائه بدیم؟ (چرا باید کارهامون رو متن‌باز کنیم؟)
  نرم‌افزارهای آزاد، مزایای بسیار زیادی دارن اما مهمه که مشخص کنیم می‌خوایم روی چه اهدافی تمرکز کنیم. بیشتر می‌خوایم دانش خودمون رو در اختیار دیگران قرار بدیم؟ قراره روی کمک‌های مردمی حساب کنیم؟ و...
  
• تعیین اسم برای پروژه (دستورالعمل انتخاب اسم)
• ایجاد یک ریپازیتوری آنلاین (مثل گیت‌هاب)
• اضافه کردن توضیحات کوتاه
• تعیین لایسنس
  ترجیحا از GPLv3 استفاده بشه
  قرار دادن لایسنس با نام LICENSE.md در دایرکتوری اصلی پروژه
  
• تنظیمات عمومی ریپازیتوری (فعال کردن issues، ویکی و ...)
• قالب پیشفرض پایادل
• قرار دادن README در دایرکتوری اصلی پروژه (نمونه READMEهای خوب و ابزارها)
  اسم + لوگو
  اضافه کردن Badge: به عنوان مثال shields (خصوصا میزان پوشش تست کدها مهمه)
  توضیح کوتاه (چه مشکلی وجود داره؟ این پروژه چطور مشکلات رو حل میکنه؟)
  نشون بدیم پروژه در عمل چطوریه (اضافه کردن عکس، گیف، ویدئو، نسخه آنلاین)
  بیان کردن الزامات و نیازمندی‌ها (مثل سیستم‌عامل خاص، شرایط سخت‌افزاری، برنامه‌های مورد نیاز و...)
  راهنمای شروع سریع به صورت گام به گام (نصب یا استفاده)
  لیست تغییرات (Changelog) (در صورت نیاز، قرار دادن در فایل CHANGELOG.md)
  لیست امکانات
  مستندات (Documents)
  نقشه راه (Roadmap)
  راهنمای مشارکت و کمک کردن (Contributing): اشاره به قالب‌ها، نحوه اجرای کدها و تست‌ها و...
  لیست مشارکت‌کنندگان و بیان قدردانی و تشکر
  پشتیبانی و راه ارتباطی
  لایسنس
  
• اضافه کردن فایل‌های مربوط به قوانین مشارکت (contributing guidelines)
  تعیین قالب برای issue و pull request
  قالب برای پیشنهاد ویژگی جدید
  پاسخ به سوالات مربوط به مشارکت و همکاری
• تعیین منشور اخلاقی (Code of Conduct)
• استفاده از ورژن‌بندی معنادار
• تکمیل مستندسازی‌ها
• پیدا کردن کاربر برای پروژه‌
  مشخص کردن مخاطبین
  پروژه ما چه مشکلی رو چطور حل میکنه؟
  ایجاد وبسایت مستقل
  فعالیت در گروه‌های مجازی و حضوری و انجمن‌ها
• بهترین روال‌های تجربه شده برای نگهدارنده‌ها
• مدیریت و نظارت
• سنجش پروژه
  

سایر نکات:

• باید مراقب وقت و زمان مخاطب باشیم و تا جای امکان به نکات کلیدی که مخاطب دنبالش هست بپردازیم
• به عنوان قاعده کلی، توضیحات زیاد بهتر از توضیحات کمه
• باید به ویراستاری متن توجه کرد: بولد کردن‌ها، ویرگول‌ها و...
• قرار دادن لینک توضیحات برای کلمات و اصطلاحاتی که ممکنه مخاطب باهاش آشنا نباشه
• مخاطبین ما برنامه‌نویس هستن و کدها رو بهتر از متن متوجه میشن. پس تا جای ممکن از کدها استفاده بشه

لینک‌های مرتبط:

https://opensource.guide

https://mozillascience.github.io/working-open-workshop/contributing/

What does a sustainable open source project look like?

دوست داری به بقیه کمک کنی؟
+ اگر نظر و پیشنهادی داری همینجا مطرح کن تا این مطلب کامل‌تر بشه
+ این مطلب رو برای کسایی که نیاز دارن بفرست
+ این مطلب رو لایک کن