WidgetCoreمستندات WidgetCore

مشارکت در توسعه

راه‌های مشارکت در افزونه‌ی متن‌باز WidgetCore؛ از گزارش مشکل و بازخورد تا بهبود مستندات، ترجمه و کمک کدنویسی.

WidgetCore یک افزونه‌ی متن‌باز با پروانه‌ی GPL است و رشد آن به کمک جامعه‌ی کاربران وابسته است. برای مشارکت لازم نیست برنامه‌نویس باشید؛ هر بازخورد دقیق و مستند هم یک مشارکت ارزشمند است.

گزارش مشکل

پیش از هر چیز صفحه‌ی عیب‌یابی را ببینید؛ بسیاری از مشکلات رایج آنجا با راه‌حل آمده‌اند. اگر مشکل پابرجا بود:

  • آن را در بخش Issues مخزن افزونه در گیت‌هاب ثبت کنید: WidgetCore/Plugin.
  • در گزارش خود بنویسید: نسخه‌ی وردپرس، نسخه‌ی المنتور، نسخه‌ی PHP و نسخه‌ی افزونه (همه در صفحه‌ی پیش‌نیازها توضیح داده شده‌اند).
  • توضیح دهید چه انتظاری داشتید و چه اتفاقی افتاد؛ اگر می‌توانید، مسیر تکرار مشکل را گام‌به‌گام بنویسید.
  • یک مشکل را در هر گزارش جداگانه مطرح کنید تا رسیدگی ساده‌تر باشد.

پیشنهاد بهبود

ایده‌های تازه برای ویجت‌ها، کنترل‌ها یا بهبودهای همین مستندات را در بخش Issues مطرح کنید. پیش از پیشنهاد، نگاهی به پرسش‌های متداول و صفحه‌های راهنمای ویجت‌ها بیندازید؛ ممکن است چیزی که می‌خواهید همین حالا وجود داشته باشد و فقط لازم باشد پیدایش کنید.

بهبود مستندات و ترجمه

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

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

اگر برنامه‌نویس PHP یا JavaScript هستید:

  1. پیش از شروع کار بزرگ، ایده‌ی خود را در یک Issue مطرح کنید تا درباره‌ی دامنه‌ی آن به توافق برسیم.
  2. مخزن افزونه را در گیت‌هاب ببینید و تغییرهای پیشنهادی خود را از همان مسیر ارسال کنید.
  3. تغییرها را کوچک و متمرکز نگه دارید و رفتار جدید را با مستندات هم‌راستا کنید.
  4. افزونه زیر پروانه‌ی GPL منتشر می‌شود؛ مشارکت شما هم با همان پروانه منتشر خواهد شد.

چه چیزی را گزارش نکنیم

پرسش‌های پشتیبانی عمومی (مثلاً «چطور جستجو را در برگه‌ام بگذارم؟») در مستندات همین سایت پاسخ داده شده‌اند؛ بخش Issues برای گزارش مشکل و پیشنهاد مشخص است.