انتقل إلى محتوى الدرس

Crafting Professional README بناء ملف توثيق README.md

جهّز مستودعاتك الاحترافية بملفات README.md وLICENSE وSECURITY.md، واحمِ الفرع الرئيسي بقواعد الحماية، وامنع تسرب المفاتيح والأسرار البرمجية.
1 صفوف تعليمية
Version Control
0 مشاهدة

شرح صفوف ومحتوى الفقرة

الصف 1 شرح توضيحي

يبدأ كل مستودع احترافي بملف توثيق واضح باسم README.md في مجلده الجذري؛ إذ تعرضه منصة GitHub تلقائياً كواجهة رئيسية للمشروع فور فتح صفحته، مما يجعله الانطباع الأول لأعضاء الفريق ومديري التوظيف والمستخدمين.

ويجب أن يجيب ملف README.md المتكامل عن أربعة أسئلة خلال ثوانٍ: ماذا يفعل هذا المشروع؟، وما المتطلبات المسبقة لتشغيله؟، وكيف أثبّته وأشغّله محلياً خطوة بخطوة؟، وكيف أشغّل الاختبارات؟

مخطط يوضح ملفات توثيق المستودع القياسية وقواعد حماية الفرع الرئيسي وأمن الأسرار وملفات البيئة
Shell
git add README.md
git commit -m "docs: add setup and test commands to README"
git push