نرحب بالمساهمات من المطورين والكتّاب التقنيين وأي شخص مهتم بتحسين تحليل كشوف الحسابات البنكية لمجتمع المالية.
كيفية المساهمة
الإبلاغ عن المشكلات
وجدت خطأ أو لديك طلب ميزة؟ افتح مشكلة على GitHub. يرجى تضمين:
- وصف واضح للمشكلة أو الاقتراح.
- خطوات إعادة الإنتاج (للأخطاء).
- إصدار Python ونظام التشغيل الخاص بك.
إرسال الكود
- انسخ المستودع (Fork).
- أنشئ فرع ميزة (
git checkout -b feature/your-feature). - اكتب اختبارات لتغييراتك (نشترط تغطية فروع 100%).
- شغّل مجموعة الاختبارات:
pytest. - أرسل طلب سحب (Pull Request) مع وصف واضح.
تحسين التوثيق
تحسينات التوثيق مرحب بها دائماً. يمكنك:
- إصلاح الأخطاء المطبعية أو توضيح المحتوى الموجود.
- إضافة أمثلة استخدام جديدة إلى مجلد الأمثلة.
- تحسين سلاسل التوثيق في الكود المصدري.
إعداد بيئة التطوير
git clone https://github.com/sebastienrousseau/bankstatementparser.git
cd bankstatementparser
python3 -m venv .venv && source .venv/bin/activate
pip install poetry && poetry install --with dev
pytest # Run the test suite
معايير الكود
- يجب أن يجتاز كل الكود فحص
ruffوالتحقق من الأنواع بـmypy. - يجب توقيع جميع الالتزامات.
- يجب أن تحافظ جميع طلبات السحب على تغطية فروع 100%.
- اتبع أسلوب وأنماط الكود الموجودة.
رعاية المشروع
إذا كان محلل كشوف الحسابات البنكية يوفر وقت فريقك، فكر في رعاية المشروع على GitHub. دعمك يساعدنا في صيانة المكتبة وتحسينها.