ابدأ بقالب يركز على المستخدم
استبدل كل حقل بين الأقواس بمعلومات متحقق منها. احذف الأقسام غير ذات الصلة بدلًا من اختلاق ميزات. إذا لم تتطلب الترقية أي إجراء، فاذكر ذلك صراحة بعد التحقق من مسار الترقية المدعوم.
# [الإصدار] — [تاريخ الإصدار]
## أبرز التغييرات
- [تحسين يلاحظه المستخدم ومن يستفيد منه]
## الترقية
- من: [الإصدار السابق المدعوم]
- الإجراء: [الترحيل المطلوب أو عدم الحاجة إلى إجراء]
- التحقق: [كيفية تأكيد نجاح الترقية]
## التغييرات غير المتوافقة
- [السلوك المتغير والمستخدمون المتأثرون ورابط الترحيل]
## الإصلاحات
- [المشكلة المحلولة ورابط البلاغ أو طلب السحب]
## المشكلات المعروفة
- [القيد المتبقي والحل البديل]
## المساهمون
[اشكر المساهمين وأضف رابط سجل التغييرات الكامل]حوّل الملاحظات المُولّدة إلى شرح واضح
يمكن لـGitHub توليد ملاحظات تتضمن طلبات السحب المدمجة والمساهمين ورابط سجل التغييرات الكامل. تعامل مع الناتج كمسودة. تحقق من حدود الإصدار، واحذف البنود غير ذات الصلة، واجمع التغييرات بحسب المهام التي يؤديها المستخدمون.
مثلًا، لا تقدم عبارة «إصلاح حالة حدية في المحلل» إرشادًا كافيًا. إذا كان ذلك دقيقًا، فاشرح أن ملفات CSV ذات العمود الأخير الفارغ تُستورد الآن بشكل صحيح، وأرفق رابط الإصلاح للتفاصيل التقنية. لا تدّعِ حل كل مشكلات التحليل عندما تغيرت حالة واحدة فقط.
راجع مسار الترقية قبل الإعلان
جرّب الترقية الموثقة من إصدار سابق مدعوم. تحقق من روابط التنزيل وتأكد من توافق الوثائق مع الإصدار. ميّز النسخة التجريبية عن الإصدار المستقر، واجعل القيود المتبقية سهلة العثور عليها.
انشر معلومات الإصدار قبل وضع رابطها في منشور للمجتمع. استخدم الإعلان لإبراز تحسين مهم واحد، بينما تبقى ملاحظات الإصدار المرجع المفصل. اجمع الأسئلة اللاحقة ووضّح التعليمات عند الحاجة.
أسئلة شائعة
هل ملاحظات الإصدار هي نفسها سجل التغييرات؟
هناك تداخل بينهما. يسجل سجل التغييرات التعديلات عبر الزمن؛ وتشرح ملاحظات الإصدار إصدارًا معينًا وتأثيره على المستخدمين. اربطهما ليتمكن القراء من الانتقال بين النظرة العامة والتفاصيل.
هل يمكنني نشر الملاحظات المُولّدة تلقائيًا دون تعديل؟
راجعها أولًا. قد تغفل عناوين طلبات السحب المُولّدة خطوات الترحيل أو الأثر على المستخدم أو المشكلات المعروفة.
هل ينبغي ذكر كل تغيير صغير في الشيفرة ضمن أبرز التغييرات؟
لا. خصص أبرز التغييرات لما يهم المستخدمين، واترك التاريخ التقني المفصل في سجل التغييرات المرتبط.