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