سجل التغييرات

سجل التغييرات هو قائمة بالتغييرات التي أُجريت على البرامج التي تم تنقيحها بمرور الوقت، مثل قاعدة البيانات أو المنتج . [ 1 ]
يمكن أن يكون سجل التغييرات سجلاً مُنسقاً. يستطيع مُنشئ سجل التغييرات عرض المعلومات بطريقة سهلة الفهم والاستخدام. بالنسبة لمشروع برمجي وإصدار برمجي ، غالباً ما يُنظم سجل التغييرات على شكل إصلاحات للأخطاء وميزات جديدة.
يمكن أن يكون سجل التغييرات تقريرًا مُنشأً يتضمن جميع التغييرات بغض النظر عن سهولة استخدامه أو فهمه. عادةً، يُمكن لنظام التحكم في الإصدارات ، مثل Git، إنشاء قائمة بتغييرات الكود، لكن البعض يرى ذلك غير مُفيد ويُفضل قائمة مُنسقة بالتغييرات البارزة. [ 2 ] [ 3 ] مثال آخر على سجل التغييرات المُنشأ هو سجل التغييرات في مواقع الويكي ، حيث يُدرج التغييرات التي أُجريت على كل مقالة. على وجه الخصوص، تُوفر ويكيبيديا هذه الميزة عبر رابط "عرض السجل" في صفحة كل مقالة. [ 4 ]
يختلف اسم ملف سجل التغييرات. من الأسماء الشائعة "CHANGELOG" و"CHANGES" و"HISTORY". [ 3 ] أما اصطلاح التسمية في GNU Automake فهو "ChangeLog". [ 5 ] أحيانًا يتضمن اسم الملف امتدادًا للدلالة على تنسيقه ، مثل ".txt" للنصوص ، و".md" لملفات Markdown ، و".rst" لملفات reStructuredText . غالبًا ما تتضمن قاعدة البيانات ، وخاصةً مشاريع البرمجيات مفتوحة المصدر ، ملف سجل التغييرات في المستوى الأعلى من شجرة دليل التوزيع .
أحيانًا، تُضمّن معلومات تقتصر على التغييرات الأخيرة في إصدار المنتج. وقد تُعرض هذه المعلومات كميزة أو في ملف يحمل اسمًا مثل "الأخبار" أو "التغييرات الأخيرة" أو " ملاحظات الإصدار ".
شكل
بشكل عام، يختلف تنسيق سجل التغييرات اختلافًا كبيرًا، لكن معايير برمجة جنو تنص على أن سجل التغييرات يُنظّم على شكل كتل، تُحدد كل منها وقت إجراء التغيير ومن قام به (الاسم وعنوان البريد الإلكتروني)، وتصف كل تغيير ضمن دالة أو ملف. يوجد مسافتان بين التاريخ والاسم، وبين الاسم وعنوان البريد الإلكتروني. من الشائع وضع عنوان البريد الإلكتروني بين علامتي < و > . يقوم محرر إيماكس بإنشاء هذه الإدخالات عند إنشاء إدخالات إضافية في سجل التغييرات. [ 6 ]
على سبيل المثال:
YYYY-MM-DD ␣␣ جون دو ␣␣ <johndoe@example.com > * myfile.ext (myfunction): التغييرات التي أجريتها تغييرات إضافية. * myfile.ext (تغيير غير ذي صلة): التغييرات التي أجريتها إلى myfile.ext ولكن لا علاقة له بما سبق ذكره. * anotherfile.ext (somefunction): المزيد من التغييرات التي أجريتها.
انظر أيضاً
- التحكم في التغييرات – عملية تضمن التحكم في التغييرات التي تطرأ على المنتج أو النظام
- Diff – أمر shell لمقارنة محتوى الملفات
- ملف السجل – سجل زمني لعمليات معالجة بيانات الحاسوب. صفحات تعرض أوصافًا مختصرة لأهداف إعادة التوجيه.
- ملف معلومات البرنامج ( README )
- خارطة طريق التكنولوجيا – أسلوب التخطيط
- موجز الويب - تنسيق البيانات
ملحوظات
- ↑ ليوكو، كارولين (2021). علاقات المطورين: كيفية بناء وتنمية برنامج مطورين ناجح . بيركلي، كاليفورنيا: Apress LP، الصفحات 189-194 . ISBN 978-1484271636.
- ↑ أتلاسين. "ما هو نظام التحكم في الإصدارات | برنامج تعليمي حول Git من أتلاسين" . أتلاسين . تم الاطلاع عليه بتاريخ 17 فبراير 2022 .
- 1 2 "احتفظ بسجل التغييرات" . keepachangelog.com .
- ↑ مساعدة: سجل الصفحات
- ↑ دليل GNU automake .
- ↑ "معايير ترميز جنو: أسلوب سجلات التغيير" . Gnu.org . تم الاطلاع عليه بتاريخ 2019-09-03 .
روابط خارجية
- ملفات الكمبيوتر
- ثقافة البرمجيات الحرة والوثائق
- الاتصالات التقنية
