تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- SymPy
- الكاتب الفني:
- Soumi7
- اسم المشروع:
- الاتساق في جميع مستندات وصف الدوال البرمجية - مستندات Sympy
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
ملخص :
الحالة الحالية لمستندات Sympy والعمل السابق :
اكتمل العمل على إنشاء دليل رسمي للأنماط في SymPy.
أنشأ مشروع GSoD الخاص بـ Lauren Glattly دليل أسلوب لسلاسل مستندات SymPy، والتي يمكن العثور عليها في دليل أسلوب توثيق SymPy.
تم تعديل سلاسل نص وصف الدوال البرمجية في وحدة النموذج الفرعي الخاصة وملف solvers.py لاتّباع إرشادات دليل الأنماط الجديد بشكلٍ متّسق.
كان لا يزال يتعين تعديل جميع ملفات نص وصف الدوال البرمجية الأخرى في قاعدة البيانات للتوافق مع دليل الأنماط الجديد أيضًا.
العمل المقترَح :
لا تزال معظم سلاسل النصوص البرمجية في SymPy لا تلتزم بأحدث دليل أسلوب. سيكون الهدف من هذا المشروع هو تحديث سلاسل المعلومات في جميع أنحاء SymPy للالتزام بهذا الدليل.
ناقشت المشروع مع المرشدين. في ما يلي رابط يؤدي إلى المناقشة.
تمّ الاتفاق على أنّ تعديل ملفات نص وصف الدوالّ البرمجية في جميع أنحاء قاعدة بيانات sympy للالتزام بأحدث دليل أسلوب هو مهمة كبيرة ويجب أن يقتصر المشروع عليها.
سيتضمّن عملي في المشروع تنفيذ الدليل الجديد لتعديل مستندات وصف الدوالّ البرمجية الحالية، مع جمع التناقضات الأخرى ومعالجتها، مثل استخدام اللغة أو المصطلحات.
يمكن تغيير ترتيب الأقسام الفرعية الحالية أو تحديده لاحقًا أو كمهمة منفصلة.
توضيح الاختلافات في النتائج عند تمرير قيم مختلفة إلى المَعلمات من خلال إضافة المزيد من الأمثلة إلى جانب قسم المَعلمات
واحرص على إضافة أمثلة صعبة إلى قسم "المشاكل والصعوبات".
المساهمات: - #17887 : عملت على حلّ المشكلة رقم 17887: إضافة أقسام نص وصفي غير متوفّرة في وحدة فرعية خاصة. أضفت قسم "المَعلمات والأمثلة" غير المتوفّر في بعض وظائف وحدة "العروض الخاصة" الفرعية التي عدّلها "لؤي". يجب أن يتّبع Glattly أحدث إرشادات التنسيق وأن يكون نموذجًا لسلاسل النصوص البرمجية المستقبلية.
إليك رابط العلاقات العامة المدمجة الخاصة بي : https://github.com/sympy/sympy/pull/19334
- #19591 : تتتبّع المشكلة رقم 19591 دليل الإرشادات حول مستندات المطوّرين. لقد أضفتُ طلب مراجعة لتعديل نص وصف core.sympify للالتزام بأحدث دليل أسلوب. لقد أضفت توضيحات وأمثلة منظَّمة حول استخدام المَعلمات المختلفة.
في ما يلي رابط لطلب إعادة النظر: https://github.com/sympy/sympy/pull/19613
أهداف المشروع
المخطط الزمني قبل 17 آب (أغسطس):
- مواصلة تقديم المساهمات للمؤسسة
- تعرَّف أكثر على مستندات المستخدم والإصدار الحالي من sympy.
- تعلّم الأساليب والمهارات التي ستساعدك أثناء تنفيذ المشروع.
تعزيز الترابط في المنتدى : (من 17 آب/أغسطس إلى 13 أيلول/سبتمبر 2020)
- يمكنك تحديد قناة تواصل ووقت (بسبب الاختلاف الزمني).
- صقل أهدافي وتحديد التوقعات من الجانبين.
- مناقشة الترتيب الذي سيتم به تعديل الوحدات
- حدِّد ترتيب تعديل الوحدات لتتوافق مع أحدث دليل على أسلوب نص وصف الدالة.
فترة إعداد المستندات (من 14 أيلول (سبتمبر) 2020 إلى 30 تشرين الثاني (نوفمبر) 2020) :
حدِّد أهدافًا لتحقيقها كل أسبوع، ويُفضَّل إكمال تعديل ملفات نص وصف الدوال البرمجية لمكوّن أو وحدة فرعية واحدة في الأسبوع أو أكثر.
بالنسبة إلى جميع هذه الوحدات، سيكون هدفي الأساسي إضافة أقسام مفقودة وإعادة هيكلة سلاسل المستندات لاتباع أحدث إرشادات. وسيتضمّن ذلك توضيح النتائج المختلفة التي يتم الحصول عليها عند تمرير قيم مختلفة إلى المَعلمات. ستتم إضافة جميع النتائج الصعبة إلى قسم "المشاكل والصعوبات".
الأسبوع 1 (14 أيلول (سبتمبر) - 21 أيلول (سبتمبر)) : الأساسيات
الأسبوع 2 (من 22 إلى 29 أيلول/سبتمبر) : الدوالّ : الوحدات الفرعية الحسابية
الأسبوع 3 (من 30 أيلول (سبتمبر) إلى 6 تشرين الأول (أكتوبر)) : الدوالّ
الأسبوع 4 (7 تشرين الأول (أكتوبر) - 14 تشرين الأول (أكتوبر)) : تبسيط، تشفير
الأسبوع 5 (15 أكتوبر - 21 أكتوبر) : ديوفانتين
الأسبوع 6 (من 22 تشرين الأول (أكتوبر) إلى 29 تشرين الأول (أكتوبر)):وحدة فرعية للعمليات :Holonomic
الأسبوع 7 (من 30 تشرين الأول (أكتوبر) إلى 7 تشرين الثاني (نوفمبر)) : وحدة التكاملات (integrals.integrals)، احتساب التكاملات باستخدام دوال G من Meijer
الأسبوع 8 (من 8 تشرين الثاني (نوفمبر) إلى 15 تشرين الثاني (نوفمبر)) : الفيزياء، والدوالّ في نهاية وحدة الفئات، ووحدة إنشاء الرموز، والوحدة الفرعية الخاصة
الأسبوع 9 (من 16 تشرين الثاني (نوفمبر) إلى 23 تشرين الثاني (نوفمبر)) : الفيزياء، والدوالّ في نهاية وحدة الفئات، ووحدة إنشاء الرموز، والوحدة الفرعية الخاصة
الأسبوع 10 (من 24 تشرين الثاني (نوفمبر) إلى 30 تشرين الثاني (نوفمبر)) : قسم الأخطاء الشائعة
الفترة من 30 تشرين الثاني (نوفمبر) إلى 5 كانون الأول (ديسمبر) 2020، الساعة 6:00 مساءً بالتوقيت العالمي المتفق عليه : إرسال المشروع النهائي وكتابة التقرير
من 3 إلى 10 كانون الأول (ديسمبر) 2020، الساعة 6:00 مساءً بالتوقيت العالمي المتفق عليه : إرسال تقارير عن نجاح المشروع وتجربة العمل مع المرشدين
يمكن تغيير ترتيب الوحدات المذكورة هنا بعد مناقشة إضافية مع المرشدين.
وفقًا لاقتراح المرشدين، سأركّز على تعديل الوحدات الأسهل أولاً، ثم الانتقال إلى الوحدات المعقّدة.
لماذا أنا الشخص المناسب لهذا المشروع؟
أعتقد أنني الشخص المناسب لهذا المشروع لأنني لدي خبرة سابقة في الكتابة الفنية في علوم الكمبيوتر وأنا على دراية جيدة بـ git وgithub.
بما أنّني أرسلت طلبات إعادة نظر لتعديل المستندات وفقًا لأحدث دليل أسلوب في sympy وتم دمجها بنجاح، أنا واثق من سير العمل وتقديم مساهمات منتظمة.
واجهتُ بعض الأخطاء في البداية. لقد اعتدت أخيرًا على إجراء الاختبارات وإنشاء المستندات في كل مرة قبل تطبيق التغييرات لأنّ ذلك مهم جدًا.
أشعر بالارتياح الشديد للمساهمة في هذا المشروع وأتطلّع إليه.