عند العمل على مشروع معين شخصي او مشترك، سيحتاج المشروع باستمرار الى اجراء تغييرات وتعديلات عليه واعادة رفعها على منصة Github.
لذلك مهم جدًا كتابة وصف جيد لكل تغيير يتم عمله على المشروع، فاذا كنت تكتب first commit على كل تغيير الى الان! هذا الثريد لك👇🏻✨
لذلك مهم جدًا كتابة وصف جيد لكل تغيير يتم عمله على المشروع، فاذا كنت تكتب first commit على كل تغيير الى الان! هذا الثريد لك👇🏻✨
الـ Commit الجيد مهم جدًا في أي مشروع وخصوصـا المشاريع الضخمة، وفائدته لا تقتصر فقط على المجموعات الي تعمل على مشروع واحد بنفس الوقت، ولكنه مفيد للأفراد ولأي شخص يعمل على مشاريعه الخاصة.
لأنه يسهّل معرفة جميع التغيرات و سبب عملها وفي أي جزء من الكود بالضبط تم تطبيقها.🔎
لأنه يسهّل معرفة جميع التغيرات و سبب عملها وفي أي جزء من الكود بالضبط تم تطبيقها.🔎
في هذا الثريد بتكلم عن قواعد تقليدية مُتبعة في كتابة رسالة الـ Commit الجيدة حتى تكون واضحة وسهلة الفهم 👇🏻✨
عند الكتابة بهذه القواعد نقوم بتقسيم الرسالة الى 5 اجزاء وهي:
1- Type (النوع)
الغرض من النوع هو وصف فئة التغيير الي تم اجراءه على الكود.
ومن انواعه:
- Fix
ويتم استخدامه اذا كان نوع التغيير هو اصلاح خطأ.
- Feat
ويتم استخدامه اذا كان نوع التغيير هو اضافة ميزة جديدة للكود.
1- Type (النوع)
الغرض من النوع هو وصف فئة التغيير الي تم اجراءه على الكود.
ومن انواعه:
- Fix
ويتم استخدامه اذا كان نوع التغيير هو اصلاح خطأ.
- Feat
ويتم استخدامه اذا كان نوع التغيير هو اضافة ميزة جديدة للكود.
2- Optional Scope (النطاق الاختياري )
وهذا القسم يصف الوحدات والاجزاء التي تأثرت بالتغيير الي تم اجراءه على الكود.
يتم كتابة السكوب في اقواس ونراعي انه يكون اسم (noun)، وهذا القسم يعتبر قسم اختياري.
وهذا القسم يصف الوحدات والاجزاء التي تأثرت بالتغيير الي تم اجراءه على الكود.
يتم كتابة السكوب في اقواس ونراعي انه يكون اسم (noun)، وهذا القسم يعتبر قسم اختياري.
3- Description (الوصف)
في هذا القسم بنقوم بوصف وشرح جميع التعديلات الي سويناها في هذا الـ commit بشكل موجز وقصير.
لازم نراعي هنا اننا نكتب جميع الافعال بصيغة الامر (Imperative) مثال:
كتابة add بدلاً من added أو adds .
في هذا القسم بنقوم بوصف وشرح جميع التعديلات الي سويناها في هذا الـ commit بشكل موجز وقصير.
لازم نراعي هنا اننا نكتب جميع الافعال بصيغة الامر (Imperative) مثال:
كتابة add بدلاً من added أو adds .
4- Optional Body (المحتوى الاختياري)
هذا القسم أيضًا يعتبر قسم اختياري، ويتم فيه كتابة جميع التغييرات الي تم قمت بها وسببها.
ولكن اذا كان الـ Commit بسيط وغير معقد بشكل كبير، مابنحتاج اننا نكتب هذا القسم عند كتابة الرسالة.
هذا القسم أيضًا يعتبر قسم اختياري، ويتم فيه كتابة جميع التغييرات الي تم قمت بها وسببها.
ولكن اذا كان الـ Commit بسيط وغير معقد بشكل كبير، مابنحتاج اننا نكتب هذا القسم عند كتابة الرسالة.
5- Optional Footer (التذييل الاختياري)
عند كتابته لابد ان نترك سطر فارغ بينه وبين المحتوى الاختياري، ويتم كتابة رمز مثل علامة هاشتاق او النقطتين متبوعة بالكلمة في التذييل.
عند كتابته لابد ان نترك سطر فارغ بينه وبين المحتوى الاختياري، ويتم كتابة رمز مثل علامة هاشتاق او النقطتين متبوعة بالكلمة في التذييل.
هذا القسم أيضًا يعتبر قسم اختياري، ولكنه يستخدم بشكل اساسي في ادوات تعقب الاخطاء والمشاكل في المشاريع الضخمة للاشارة الى معرّف المشكلة (id) والبيانات الوصفية الاخرى مثل طريقة التطوير المستخدمة واسم المطوّر.
جاري تحميل الاقتراحات...