@عادل بن يحي
السلام عليكم ورحمة الله وبركاته
أود بداية أن أشكركم على جهودكم الكبيرة في مشروع quran-search-engine وجعل الوصول إلى القرآن والتفاعل معه أكثر سهولة وفاعلية.
اردت المساهمة في تحسين توثيق المشروع، إلا أنني لم أتمكن من العثور على خيار لفتح مشكلة جديدة (New Issue) خاصة بالتوثيق في المستودع على GitHub.
ولذلك، أود اقتراح ما يلي لتحسين ملف CONTRIBUTING.md وتسهيل مساهمة المطورين الجدد:
إرشادات الاختبارات:
مكان ملفات الاختبارات وكيفية تسميتها
كيفية كتابة اختبار جديد
كيفية تشغيل اختبار محدد أثناء التطوير
تسمية الفروع:
اقتراح نمط واضح للفروع مثل fix/normalize-bug، feat/add-react-example لتسهيل متابعة التعديلات
رسائل الالتزام:
توضيح إذا كان المشروع يتبع Conventional Commits، مع أمثلة واضحة
تحديث CHANGELOG:
إضافة مثال لكيفية كتابة التعديلات تحت قسم [Unreleased]
مجلد الأمثلة:
شرح كيفية تشغيل الأمثلة محليًا، مثل:
pnpm --filter vite-demo dev
أعتقد أن هذه التحسينات الصغيرة ستسهل على المساهمين الجدد البدء بالمساهمة وتجعل المشروع أكثر ترحيبًا، خصوصًا من لم يسبق له العمل مع monorepo أو pnpm.
أنا مستعدة لفتح Pull Request يغطي هذه النقاط إذا رأيت أن هذا الاتجاه مناسب، وسأكون ممتنة لتوجيهك حول كيفية إنشاء issue خاصة بالتوثيق في المستودع.
جزاك الله خيرًا وبارك الله في جهودك,
