ceald1/evilwinrm-ngعميل WinRM مبني على Go لتنفيذ الأوامر عن بعد والحركة الجانبية على أنظمة Windows أثناء اختبارات الاختراق.
لتسهيل البدء مع GitLab، إليك قائمة بالخطوات التالية الموصى بها.
هل أنت محترف بالفعل؟ فقط قم بتحرير هذا الملف README.md واجعله خاصًا بك. هل تريد تسهيل الأمر؟ استخدم القالب في الأسفل!
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.git
git branch -M main
git push -uf origin main
استخدم التكامل المستمر المدمج في GitLab.
عندما تكون مستعدًا لجعل هذا الملف README خاصًا بك، فقط قم بتحرير هذا الملف واستخدم القالب المفيد أدناه (أو لا تتردد في هيكلته كما تريد - هذه مجرد نقطة بداية!). الشكر لـ makeareadme.com على هذا القالب.
كل مشروع مختلف، لذا فكر في أي من هذه الأقسام ينطبق على مشروعك. الأقسام المستخدمة في القالب هي اقتراحات لمعظم المشاريع مفتوحة المصدر. ضع في اعتبارك أيضًا أنه على الرغم من أن ملف README يمكن أن يكون طويلاً ومفصلاً، إلا أن الطويل أفضل من القصير. إذا كنت تعتقد أن ملف README طويل جدًا، ففكر في استخدام شكل آخر من التوثيق بدلاً من قطع المعلومات.
اختر اسمًا واضحًا بذاته لمشروعك.
دع الناس يعرفون ما يمكن لمشروعك فعله بالتحديد. قدم سياقًا وأضف رابطًا لأي مرجع قد لا يكون الزوار على دراية به. يمكن أيضًا إضافة قائمة بالميزات أو قسم فرعي عن الخلفية هنا. إذا كانت هناك بدائل لمشروعك، فهذا مكان جيد لذكر العوامل المميزة.
في بعض ملفات README، قد ترى صورًا صغيرة تنقل بيانات وصفية، مثل ما إذا كانت جميع الاختبارات ناجحة للمشروع. يمكنك استخدام Shields لإضافة بعضها إلى ملف README الخاص بك. العديد من الخدمات لديها أيضًا تعليمات لإضافة شارة.
اعتمادًا على ما تصنعه، قد تكون فكرة جيدة تضمين لقطات شاشة أو حتى فيديو (سترى غالبًا GIFs بدلاً من فيديوهات فعلية). أدوات مثل ttygif يمكن أن تساعد، ولكن تحقق من Asciinema لطريقة أكثر تطورًا.
داخل نظام بيئي معين، قد تكون هناك طريقة شائعة لتثبيت الأشياء، مثل استخدام Yarn أو NuGet أو Homebrew. ومع ذلك، ضع في اعتبارك إمكانية أن يكون من يقرأ ملف README مبتدئًا ويحتاج إلى مزيد من التوجيه. يساعد سرد خطوات محددة في إزالة الغموض ويمكن الأشخاص من استخدام مشروعك بأسرع وقت ممكن. إذا كان يعمل فقط في سياق معين مثل إصدار لغة برمجة معينة أو نظام تشغيل أو لديه تبعيات يجب تثبيتها يدويًا، فأضف أيضًا قسمًا فرعيًا عن المتطلبات.
استخدم الأمثلة بكثرة، وأظهر المخرجات المتوقعة إذا أمكن. من المفيد أن يكون لديك أصغر مثال على الاستخدام يمكنك عرضه مباشرة، مع تقديم روابط لأمثلة أكثر تطورًا إذا كانت طويلة جدًا بحيث لا يمكن تضمينها بشكل معقول في ملف README.
أخبر الناس أين يمكنهم الذهاب للحصول على المساعدة. يمكن أن يكون أي مجموعة من متتبع المشكلات أو غرفة دردشة أو عنوان بريد إلكتروني، إلخ.
إذا كانت لديك أفكار لإصدارات مستقبلية، فمن الجيد إدراجها في ملف README.
اذكر ما إذا كنت منفتحًا على المساهمات وما هي متطلباتك لقبولها.
بالنسبة للأشخاص الذين يرغبون في إجراء تغييرات على مشروعك، من المفيد وجود بعض التوثيق حول كيفية البدء. ربما يوجد سكريبت يجب تشغيله أو بعض متغيرات البيئة التي يحتاجون إلى تعيينها. اجعل هذه الخطوات واضحة. يمكن أن تكون هذه التعليمات مفيدة أيضًا لنفسك في المستقبل.
يمكنك أيضًا توثيق أوامر لفحص الكود أو تشغيل الاختبارات. تساعد هذه الخطوات في ضمان جودة عالية للكود وتقليل احتمالية أن تؤدي التغييرات عرضةً إلى كسر شيء ما. وجود تعليمات لتشغيل الاختبارات مفيد بشكل خاص إذا كان يتطلب إعدادًا خارجيًا، مثل بدء خادم Selenium للاختبار في متصفح.
أظهر تقديرك لأولئك الذين ساهموا في المشروع.
للمشاريع مفتوحة المصدر، اذكر كيفية ترخيصها.
إذا نفدت طاقتك أو وقتك لمشروعك، ضع ملاحظة في أعلى ملف README تفيد بأن التطوير قد تباطأ أو توقف تمامًا. قد يختار شخص ما تفريع مشروعك أو التطوع للدخول كصيان أو مالك، مما يسمح لمشروعك بالاستمرار. يمكنك أيضًا تقديم طلب صريح لصيانة.