CONTRIBUTING.md

المساهمة

عند المساهمة في هذا المستودع، يرجى أولاً معرفة التغيير الذي ترغب فيه، هل يقوم بحل مشكلة او إضافة ليست متواجدة او غيرها. يرجى ملاحظة أن لدينا قواعد السلوك، يرجى اتباعها في جميع تعاملاتك مع المشروع.

إعداد بيئة التطوير

[?] تابع وصف كيفية إعداد بيئة التطوير المحلية المتعلقة في لغة Cairo. على منصة Web3Arabs او من هنا.

لإعداد المستودع على جهازك، يرجى اتباع الخطوات التالية:

1- إستدعاء المشروع

git clone https://github.com/Web3Arabs/starknet-course
cd starknet-course

2- البدء في الإستكشاف

هيكل المستودع:

• المجلد course

ستتمكن من رؤية جميع الدروس المتواجدة على منصة Web3Arabs، يمكنك البدء في المساهمة في تطوير الدروس والتعديل عليها. وفي حال لديك بعض الدروس التي تريد كتابتها يمكنك إنشاء وإضافتها وسنقوم بمراجعتها ومن ثم الموافقة عليها.

• المجلد examples

ستجد في هذا المجلد كل الأمثلة التي كنا نقوم بكتابتها في الدروس أو ورشات العمل. يمكنك البدء في تجربتها وحل مشاكلها عن طريق تشغيل الأمر التالي:

cd examples
scarb cairo-run && scarb build

• المجلد projects

ستجد في هذا المجلد المشاريع التي قمنا بإنشائها في الدروس وورشات العمل بالكامل.

• المجلد starklings-cairo1

ستجد في هذا المجلد المشاكل التي قمنا في حلها في أحد ورشات العمل التي قمنا بتسجيلها.

القضايا (Issues) وطلبات الميزات

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

يرجى محاولة إنشاء تقارير الأخطاء التي تكون:

• قابلة للبناء. قم بتضمين خطوات البناء التي ستعمل عليها.
• محدد. قم بتضمين أكبر قدر ممكن من التفاصيل: أي إصدار، وما هي البيئة، وما إلى ذلك.
• فريد. لا تكرر القضايا الموجودة.
• نطاق محدد لكل قضية. قضية واحدة لكل مشكلة او ميزة. لا تقوم بكتابة العديد من المزايا او المشاكل في قضية (Issue) واحدة.

والأفضل من ذلك: أرسل طلب نشر حل المشكلة أو الميزة الجديدة بشكل مباشر.

كيفية تقديم طلب نشر

1- قم أولاً بالتحقق من طلبات النشر التي لم يتم دمجها إلى المشروع حتى الان - حتى لا تقوم بتضييع وقتك في التعديل على اشياء قد قام احدهم بفعلها.

2- قم بإنشاء شوكة (Fork) للمشروع.

3- بعد الإنتهاء من التعديل الخاص بك قم بإضافة التعديلات

git add .

4- قم بإنشاء Commit لتعديلاتك

git commit -m "Add an amazing future"

5- نشر التعديلات إلى الشوكة (Fork) الخاصة بك

git push

6- قم بفتح طلب نشر التعديلات الخاصة بك

في حال واجهة أي مشاكل اثناء عملية المساهمة يمكنك التواصل معنا على تويتر أو التليجرام.