Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 2.24 KB

راهنمای مشارکت

با تشکر از شما برای علاقه‌مندی شما به مشارکت در پروژه! من از هر گونه مشارکت استقبال می‌کنم و قدردانی می‌کنم،

انواع مشارکت

  • تغییرات در dataset: برای اینکار فایل data.txt و data.json را ویرایش کنید و تغییرات خود را اعمال کنید.
  • کار روی توابع زبان‌های برنامه‌نویسی مختلف: اگر یک زبان از قبل موجود می‌باشد توابع نوشته شده توسط افراد دیگر را ویرایش کنید و آنها را بهبود دهید. اگر توابع زبان برنامه‌نویسی مورد نظرتان وجود ندارد آن را به پروژه اضافه کنید.

چگونه می‌توانم مشارکت کنم؟

برای شروع، ابتدا موارد زیر را بررسی کنید:

  1. پروژه را fork کنید: ابتدا پروژه را به حساب کاربری خود در گیت‌هاب fork کنید.
  2. یک branch ایجاد کنید: برای هر تغییر یا اضافه‌ای که می‌خواهید انجام دهید، یک branch جدید ایجاد کنید.
  3. تغییرات خود را اعمال کنید: تغییرات مورد نظر خود را در branchعی که ایجاد کرده‌اید، انجام دهید.
  4. یک درخواست Pull Request (PR) ارسال کنید: پس از اعمال تغییرات، یک درخواست PR به پروژه اصلی ارسال کنید.

دستورالعمل‌های مشارکت

برای اطمینان از کیفیت بالای پروژه و نگهداری مستندات به شکلی یکپارچه، لطفا دستورالعمل‌های زیر را دنبال کنید:

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