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