انتقل إلى المحتوى الرئيسي
🤖AI-generated documentation☐ curatedAI Generated
This page was drafted by an AI assistant and may contain inaccuracies.
About content generation types
🤖
AI Generated — Page drafted entirely by AI from codebase or prompt instructions.
(e.g., docs generated from codebase analysis)
← this page
✋→🤖
AI Transformatted — Human provided raw material; AI restructured it into a different format.
(e.g., livestream → blog post, meeting notes → docs)
✋
Human Generated — Page written entirely by a human author.
(e.g., hand-written tutorial)
More info about content generation types ↗

المساهمة في SkellyCam

نحب مساهماتكم! نريد أن نجعل المساهمة في هذا المشروع سهلة وشفافة قدر الإمكان، سواء كان ذلك الإبلاغ عن خطأ، أو مناقشة الحالة الحالية للكود، أو تقديم إصلاح، أو اقتراح ميزات جديدة، أو أن تصبح مشرفاً.

التطوير مع GitHub​

نستخدم GitHub لاستضافة الكود وتتبع المشاكل وطلبات الميزات وقبول طلبات السحب.

تدفق عمل GitHub​

نستخدم GitHub Flow، لذا جميع تغييرات الكود تحدث عبر طلبات السحب:

  1. انسخ المستودع وأنشئ فرعك من development.
  2. إذا أضفت كوداً يجب اختباره، أضف اختبارات.
  3. إذا غيّرت واجهات API، حدّث التوثيق.
  4. تأكد من نجاح مجموعة الاختبارات.
  5. تأكد من فحص الكود (uv run ruff check skellycam/).
  6. قدّم طلب السحب!

الترخيص​

أي مساهمات تقدمها ستكون تحت رخصة AGPL للبرمجيات. عند تقديم تغييرات في الكود، يُفهم أن مساهماتك تخضع لنفس رخصة AGPL التي تغطي المشروع.

الإبلاغ عن الأخطاء​

نستخدم GitHub Issues لتتبع الأخطاء. أبلغ عن خطأ عبر فتح مشكلة جديدة.

تقارير الأخطاء الممتازة تميل لأن تحتوي على:

  • ملخص سريع و/أو خلفية
  • خطوات إعادة الإنتاج (كن محدداً!)
  • قم بتضمين ملف ZIP مرفوع لجلسة تسجيل skellycam التي أنتجت المشكلة
  • ما توقعت حدوثه
  • ما حدث فعلاً
  • ملاحظات (ربما تتضمن سبب اعتقادك بحدوث هذا، أو أشياء جربتها ولم تنجح)

إرشادات طلبات السحب​

  • أي كود يأتي عبر طلب سحب يجب أن يكون مغطى باختبارات
  • يجب أن تجتاز تلك الاختبارات سير عمل GitHub Actions قبل دمجها
  • أي تغييرات في واجهة المستخدم يجب أن تتضمن فيديو قصير للتطبيق العامل مع التغيير المضمن

أسلوب الكتابة​

نستخدم Ruff لفحص الكود. شغّل uv run ruff check skellycam/ للتحقق وuv run ruff check --fix skellycam/ للإصلاح التلقائي.

راجع دليل التطوير لمزيد من التفاصيل حول سير عمل التطوير.