هل يتم كتابة كل اللغات والتقنيات التي استخدمتها في ملف README؟

ليست بديهية حيث يمكن إنشاء مشاريع ويب بلغات أخرى، بل عليك ذكر كل اللغات التي استخدمتها في المشروع، وبخصوص المكتبات مثل Bootstrap وAxios فاذكرهم لا مشكلة في ذلك، وتستطيع ذكر كافة المكتبات التي استخدمتها، لكن من الأفضل ذكر الهام منها والأساسي بالنسبة للمشروع.

وبالنسبة للـ API فهل من سبب يدفعك لذكر ذلك؟ تستطيع كتابة وصف للمشروع في README وسيتم فهم أن المشروع يعتمد على API في تنفيذ أمر معين، وذكر أنك تستخدم Axios يدل بالتبعية على أن المشروع يستخدم API، وإذا كنت تقصد أنه يتم الإعتماد على API خارجي لتوفير المعلومات فاذكر ذلك.

ببساطة ملف README.md يوضح وصف للمشروع بشكل مختصر وواضح، بحيث يفهم القارئ وظيفة المشروع الخاص بك، ثم يعرض المميزات Features ثم صورة توضيحية لو أمكن Screenshots،  ثم الجزء الخاص بشرح إعداد المشروع، ثم الجزء الخاص بشرح طريقة استخدام المشروع إن دعت الحاجة إلى ذلك، ثم الجزء الخاصة بالتقنيات المستخدمة Tech Used.

وهناك العديد من المواقع التي توفر عليك كتابة ملف readme  وقد تم توضيحها هنا:

يفضل عدم ذكر التقنيات الأساسية مثل HTML و CSS و JavaScript في ملف Readme للمشروع، لأنها بديهية ومفترضة .فمثلاً

• عندما يرى أي شخص مشروع ويب، فهو يفترض بشكل تلقائي أنه مبني باستخدام HTML و CSS و JavaScript.
• يجب أن يركز ملف Readme على التقنيات أو المكتبات التي تم استخدامها وتميز المشروع، مثل Bootstrap أو Axios أو غيرها. هذا ما يهم القراء.
• يؤدي إلى قائمة طويلة: إذا تم تضمين التقنيات الأساسية، ستكون قائمة التقنيات في الملف طويلة للغاية وغير ضرورية.

يكفي ذكر التقنيات الإضافية التي استخدمتها لبناء المشروع، مثل:

• Bootstrap
• Axios للطلبات HTTP
• أي API خارجية استخدمت في المشروع
• أي إضافات أو مكتبات JavaScript أخرى
• أي نظام إدارة قوالب مثل Pug أو EJS

هذا يعطي القارئ فكرة أفضل عن التقنيات المتقدمة التي بني عليها المشروع.

بشكل عام، يجب على ملف Readme أن يحتوي على:

• وصف موجز للمشروع
• تعليمات التثبيت إذا تطلب الأمر
• التقنيات المستخدمة (غير الأساسية)
• شرح كيفية الاستخدام
• أي فوائد أخرى

في الملف README الخاص بمستودع المشروع على GitHub، يمكنك ذكر التقنيات التي استخدمتها في تطوير الموقع الإلكتروني. إذا كان استخدام HTML و CSS و JavaScript هو الأساس والبديهي في تطوير الموقع، فقد يكون من الافتراضي عدم الإشارة إليها بشكل صريح في README.

ومع ذلك، إذا قمت بتطبيق تقنيات أخرى مثل Bootstrap و Axios واستخدمت API، فإن ذكر هذه التقنيات الأخرى سيكون ذا قيمة وفائدة للقراء. يمكنك توضيح كيف استخدمت Bootstrap لتنظيم وتصميم الصفحات، وكيف استخدمت Axios للتواصل مع API وجلب البيانات.

بشكل عام، الملف README يعد وسيلة لتوضيح المعلومات الأساسية والهامة حول المشروع، ويفضل توضيح التقنيات والأدوات الرئيسية التي تم استخدامها في تطوير المشروع لمساعدة القراء والمساهمين المحتملين على فهم البنية والمكونات الأساسية للمشروع.

مرحبًا مجددًا,

بدايتًا أشكركم جدًا على مساعدتي,

لدي سؤال آخر بخصوص نفس الموضوع,

هل تقنية ال Regular Expressions (RegEx) يمكنني ذكرها في ملف ال README كباقي التقنيات أم لا داعي لذكرها ؟

و شكرًا لكم مجددًا