مرحبًا بكم في CAT Docs - مشروع مفتوح المصدر توثق القطط!
تتمثل فكرة هذا المشروع في الجمع بين جميع المعلومات المتعلقة بالقطط في موقع ويب واحد - سواء كان الأمر يتعلق بامتلاك قطة كحيوان أليف ، وتعلم تاريخ القط ، وجميع منتجات القط ، سمها ما شئت.
لا تتردد في المساهمة وإنشاء مشكلات جديدة لأي ملاحظات ، أو أسئلة لديك! هذا مشروع عن كل شيء وأي شيء يتعلق بالقطط ، لذلك لا تتردد في الاستكشاف!
للمبتدئين
- لا تتردد في فتح مشكلات جديدة والتعليق على القضايا الحالية إذا كنت ترغب في مواجهة المهام. يتم الترحيب بالمساعدة دائمًا!
شكرا لزيارة مستندات القط!
؟ إرشادات المساهمة:
ابدء
قم بإعداد المشروع محليًا باتباع هذه الخطوات:
شوكة المستودع :
- انقر فوق الزر "Fork" في الزاوية العلوية اليمنى من صفحة المستودع لإنشاء نسخة من المستودع ضمن حساب GitHub الخاص بك.
استنساخ شوكة الخاص بك :
- استنساخ المستودع المتشعب إلى جهازك المحلي باستخدام الأمر التالي:
git clone https://github.com/your-username/cat-docs.git
استبدل your-username باسم مستخدم GitHub الخاص بك.
انتقل إلى دليل المشروع :
تثبيت التبعيات :
- قم بتثبيت التبعيات المطلوبة باستخدام مدير الحزمة الذي تختاره. على سبيل المثال ، مع NPM:
تشغيل المشروع :
- ابدأ المشروع باستخدام أمر Vitepress لضمان عمل كل شيء بشكل صحيح:
المساهمة
تصفح القضايا :
- انظر من خلال القضايا للعثور على واحدة تهمك. التعليق على القضية لإعلام المشرفين أنك ترغب في العمل عليها. سيتم بعد ذلك تعيين المشكلة لك.
إنشاء فرع :
- إنشاء فرع جديد لعملك. استخدم اسمًا وصفيًا يتعلق بالمشكلة التي تتناولها. على سبيل المثال:
git checkout -b issue-123-add-cat-facts
قم بإجراء تغييراتك :
- قم بتنفيذ التغييرات الخاصة بك والالتزام بها إلى فرعك. اتبع معايير ترميز المشروع وارتكاب إرشادات الرسائل.
ادفع فرعك :
- ادفع فرعك إلى مستودعك المتشعب:
git push origin issue-123-add-cat-facts
إرسال طلب سحب (PR) :
- انتقل إلى المستودع الأصلي على GitHub ويجب أن ترى موجهًا لإنشاء طلب سحب. انقر فوق "قارن وسحب الطلب".
مراجعة العلاقات العامة والموافقة عليها :
- سيتم مراجعة طلب السحب الخاص بك من قبل المشرفين. يرجى التحلي بالصبر والاستجابة لأي تعليقات تتلقاها. يتمتع المحللون فقط بسلطة دمج التغييرات الخاصة بك ونشرها.
يتعلم أكثر
لمزيد من المعلومات التفصيلية حول العمل مع Forks والمساهمة في مشاريع المصدر المفتوح ، تحقق من دليل Github حول العمل مع Forks.