readme
إنشاء ملفات README مفصلة للمشاريع
تبطئ ملفات README غير المكتملة عملية الانضمام وتخفي تفاصيل الإعداد. تساعد هذه المهارة Claude وCodex وClaude Code على إنشاء توثيق واضح للإعداد والبنية والاختبار والنشر.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "readme" from https://skillstore.io/skills/sickn33-readme.md and its manifest at https://skillstore.io/api/skills/sickn33-readme/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "readme". أنشئ README لمشروع Rails يستخدم PostgreSQL وVite ومهام خلفية.
النتيجة المتوقعة:
README يحتوي على نظرة عامة على المشروع، وحزمة التقنيات، وخطوات الإعداد، ومتغيرات البيئة، وأوامر قاعدة البيانات، وملاحظات البنية، والاختبارات، وإرشادات النشر.
جارٍ استخدام "readme". حدّث README قديما بعد انتقال المشروع من npm إلى pnpm.
النتيجة المتوقعة:
README منقح يصحح تثبيت التبعيات، وأوامر خادم التطوير، وتعليمات الاختبار، وملاحظات استكشاف الأخطاء وإصلاحها.
جارٍ استخدام "readme". وثّق كيف ينبغي لمهندس جديد تشغيل هذه الخدمة محليا.
النتيجة المتوقعة:
قسم README موجه للانضمام يتضمن المتطلبات المسبقة، وعناصر نائبة للإعدادات، وخطوات التشغيل المحلي، وفحوصات التحقق، والإصلاحات الشائعة.
التدقيق الأمني
آمنThe static findings are false positives caused by markdown code fences, inline code, placeholder configuration, and user-visible README examples. No prompt injection, hidden command execution, unauthorized network access, or credential exfiltration intent was found in SKILL.md. Generated READMEs should still use placeholders for all secrets and private deployment details.
عوامل الخطر
⚙️ الأوامر الخارجية (50)
🌐 الوصول إلى الشبكة (5)
📁 الوصول إلى نظام الملفات (1)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/sickn33-readme/audits/6?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/sickn33-readme?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/sickn33-readme?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-readme/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/sickn33-readme.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>الاستشهادات الأكاديمية (APA · BibTeX · CFF)
اقتباس APA
sickn33. (2026). readme security audit report (audit version 6) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-readme/audits/6اقتباس BibTeX
@techreport{sickn33-sickn33-readme-2026,
author = {sickn33},
title = {readme security audit report (audit version 6)},
institution = {Skillstore},
year = {2026},
number = {6},
url = {https://skillstore.io/skills/sickn33-readme/audits/6},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "readme security audit report (audit version 6)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/sickn33-readme/audits/6"
identifiers:
- type: other
value: "skillstore:sickn33-readme:audit:6"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: مرتفعما الذي يمكنك بناؤه
تهيئة المشرفين الجدد
أنشئ README يشرح الإعداد والبنية والسكربتات واستكشاف الأخطاء وإصلاحها للمساهمين الجدد.
توثيق تطبيق Rails
أنشئ أقسام README للتبعيات وإعداد قاعدة البيانات وبيانات الاعتماد والاختبارات ومسارات عمل النشر.
التحضير لإصدار مفتوح المصدر
حدّث توثيق المشروع العام بالمتطلبات المسبقة وخطوات التثبيت وملاحظات الاستخدام والاختبار وإرشادات المساهمة.
جرّب هذه الموجّهات
أنشئ README.md لهذا المشروع. ضمّن خطوات الإعداد، والأوامر الشائعة، والاختبارات، ونظرة عامة قصيرة على البنية.
راجع README.md الحالي وحدّثه ليتوافق مع المستودع. أبقِ الأقسام الدقيقة وأصلح الأوامر القديمة.
أنشئ README موجها للمساهمين يتضمن المتطلبات المسبقة، والإعداد المحلي، وبنية المشروع، والاختبار، واستكشاف الأخطاء وإصلاحها، وملاحظات المساهمة.
دقق هذا المستودع وأنتج README جاهزا للإنتاج. غطِّ الإعداد والبنية والنشر والعمليات واستكشاف الأخطاء وإصلاحها. استخدم عناصر نائبة لجميع الأسرار.
أفضل الممارسات
- راجع الأوامر المولدة قبل نشر README.
- قدّم سياق العمل ومنصة النشر المستهدفة عندما لا يوضحها المستودع.
- استخدم عناصر نائبة لقيم الأسرار، وعناوين URL الخاصة، وبيانات اعتماد الإنتاج.
تجنب
- نشر توثيق مولد يتضمن بيانات اعتماد حقيقية أو مفاتيح خاصة.
- قبول تعليمات النشر دون التحقق منها مقابل منصة الاستضافة الفعلية.
- استخدام القالب الكامل لمشروع صغير يحتاج إلى README قصير.