Pythonia

بيثونيا

مرحبًا بك في Pythonia - مستودع مجموعة Python Functions! هذا مستودع عام حيث يمكن لأي شخص المساهمة في وظائف بيثون. سواء كان نصًا واحدًا أو مشروعًا أكثر تعقيدًا مقسومًا إلى ملفات متعددة ، فإن مساهماتك مرحب بها.

جدول المحتويات

• عن
• كيفية المساهمة
• المبادئ التوجيهية
• هيكل المجلد
• رخصة
• يساهم

عن

هذا المستودع هو مجموعة من وظائف Python المختلفة والبرامج النصية. الهدف من ذلك هو إنشاء مجموعة متنوعة من الوظائف المفيدة التي يمكن أن تساعد المطورين والعشاق الآخرين. يمكن أن تتراوح المساهمات من وظائف الأداة المساعدة البسيطة إلى مشاريع أكثر تعقيدًا.

كيفية المساهمة

المساهمة في هذا المستودع بسيط. اتبع الخطوات أدناه للبدء:

1. شوكة المستودع : انقر على زر Fork في الزاوية اليمنى العليا من هذه الصفحة.
2. استنساخ شوكة الخاص بك : استنساخ مستودعك المتشعب إلى جهازك المحلي.

   git clone https://github.com/ < your-username > /python-functions-collection.git

3. ** إنشاء فرع جديد: إنشاء فرع جديد لمساهماتك.

   git checkout -b my-new-function

4. أضف وظيفتك: أضف وظيفة (وظائف) Python إلى المجلد المناسب أو إنشاء وضع جديد.
5. ارتكب التغييرات الخاصة بك: ارتكب التغييرات الخاصة بك برسالة ملزمة ذات معنى.

   git add .
   git commit -m " Add new function for XYZ "

6. ادفع إلى شوكةك: ادفع التغييرات الخاصة بك إلى مستودعك المتشعب.

   git push origin my-new-function

7. قم بإنشاء طلب سحب: انتقل إلى المستودع الأصلي وانقر على زر New Pull Request .
8. قم أيضًا بتحديث ملف "REVERESS.TXT" وفقًا لمشروعك.

المبادئ التوجيهية

لضمان بقاء المستودع منظمًا ومفيدًا ، يرجى اتباع هذه الإرشادات عند المساهمة:

• تنظيم رمز في المجلدات: إذا كانت مساهمتك تتكون من ملفات أو أجزاء متعددة ، فضعها داخل مجلد. اسم المجلد بشكل وصفي.
• مساهمات الملف الفردي: إذا كانت مساهمتك عبارة عن ملف Python واحد ، فضعه مباشرة في القسم المناسب.
• اتفاقيات التسمية: استخدم أسماء وصفية للملفات والمجلدات. تجنب الأسماء العامة مثل script.py أو function.py.
• الوثائق: قم بتضمين التعليقات والموظفات في الكود الخاص بك لشرح وظائفه.
• الاختبار: إن أمكن ، قم بتضمين برنامج نصي اختبار صغير أو مثال يوضح كيفية استخدام وظيفتك.
• معلومات الترخيص: تأكد من أن مساهماتك متوافقة مع ترخيص المستودع (انظر أدناه).

هيكل المجلد

تنظيم المستودع بطريقة مفيدة. إليك هيكل مثال:

  Pytonia/
  |
  | -- single_file_functions/
  |   | -- example_function.py
  |
  | -- multi_part_functions/
  |   | -- project_name/
  |       | -- part1.py
  |       | -- part2.py
  |       | -- README.md
  |
  | -- README.md

• single_file_functions: للحصول على مساهمات ملف python الفردي.
• multi_part_functions: بالنسبة للمشاريع التي تحتوي على أجزاء/ملفات متعددة. يجب أن يكون لكل مشروع مجلد خاص به.
• readme.md: هذا الملف.

رخصة

هذا المشروع مرخص بموجب ترخيص معهد ماساتشوستس للتكنولوجيا. من خلال المساهمة ، أنت توافق على أن مساهماتك سيتم ترخيصها بموجب ترخيص معهد ماساتشوستس للتكنولوجيا.

يساهم

نرحب بالمساهمات من الجميع. إليك كيف يمكنك المساعدة:

• إرسال تقارير الأخطاء وطلبات الميزات: استخدم تعقب المشكلات للإبلاغ عن الأخطاء أو اقتراح الميزات.
• مراجعة طلبات السحب: مراجعة طلبات سحب من المساهمين الآخرين.
• تحسين الوثائق: ساعد في تحسين هذا ReadMe ، إضافة التعليقات ، وتحسين وثائق الكود.