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