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