إضافة أمثلة برمجة جديدة
إرشادات المساهمة لأمثلة البرمجة
- يجب أن تكون المشاركات مكتوبة باللغة الإنجليزية.
- وثق مثالك بأكبر قدر ممكن من التفصيل.
- تأكد من أن الكود الخاص بك يعمل وقد تم اختباره بشكل صحيح.
نحتفظ بالحق في:
- تعديل مشاركتك بعد تقديمها.
- إزالة مشاركتك إذا لزم الأمر.
إنشاء مثال برمجي جديد
1. قم بعمل Fork لهذا المستودع
2. قم باستنسخ الـ Fork الخاص بك واستخدم cd للانتقال إلى دليل المشروع
3. قم بتثبيت VitePress
يمكنك العثور على متطلبات VitePress الأساسية في التوثيق الرسمي.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. أضف المثال البرمجي الخاص بك
4.1 أنشئ ملف المثال
- أنشئ ملفًا جديدًا في
/docs/examplesباسم لغة البرمجة. - يجب أن ينتهي اسم الملف بـ
.md. - قم بتضمين طريقتين مختلفين على الأقل لإجراء استدعاءات API.
4.2 أضف المثال إلى الشريط الجانبي
- افتح
/docs/.vitepress/config.mts. - حدد موقع قسم "أمثلة البرمجة" (Code Examples) في الشريط الجانبي.
- أضف ملفك الجديد إلى القائمة.
- حافظ على القائمة بالترتيب الأبجدي حسب لغة البرمجة.
5. ابدأ خادم التطوير
قبل إنشاء طلب سحب (Pull Request)، تحقق محليًا من أن تغييراتك لم تكسر أي شيء.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. أنشئ طلب سحب (Pull Request)
قدّم طلب سحب إلى المستودع الأصلي.