يحتوي هذا المستودع على الكود المصدري لوثائق المنشئ على create.roblox.com/docs.
ملحوظة : يحتوي المستودع حاليًا على أدلة وبرامج تعليمية ومحتوى تعليمي ومرجع Engine API. عينات التعليمات البرمجية ستتوفر قريبًا.
إذا لم تكن على دراية بعملية المساهمة في GitHub، فراجع حول طلبات السحب والفيديو التالي.
إذا وجدت مشكلة في الوثائق ولا تريد إرسال طلب سحب، فيرجى إخبارنا بذلك عن طريق الإبلاغ عنها في منتديات مطوري Roblox.
يجب أن تتناسب أي إضافة إلى وثائق منشئ Roblox مع الكل الأكبر. بمعنى آخر، حتى منشور مدونة شامل ودقيق ومكتوب بشكل جيد أو ورقة عمل فنية قد لا يكون له مكان على موقع الويب.
بشكل عام، نحن نبحث عن المحتوى الذي يتوافق مع معاييرنا الحالية وينطبق على مجموعة واسعة من التجارب وحالات الاستخدام. على سبيل المثال، نفضل صفحات مثل "إنشاء واجهات المستخدم" على صفحات مثل "إنشاء عداد سرعة للعبة سباق" . فكر في نشر المزيد من الأدلة المتخصصة في منتدى مطوري Roblox.
عند إرسال طلب سحب للمراجعة، يجب عليك الموافقة على ما يلي:
لقد قمت بإنشاء هذه المساهمة كليًا أو جزئيًا، ولدي الحق في تقديمها بموجب شروط تراخيص المصدر المفتوح لهذا المستودع.
أدرك وأوافق على أن هذه المساهمة وسجلها عامان، ويتم الاحتفاظ بهما إلى أجل غير مسمى، ويمكن إعادة توزيعهما بموجب شروط تراخيص المصدر المفتوح لهذا المستودع.
على حد علمي، جميع التغييرات المقترحة دقيقة.
لإجراء تغييرات بسيطة تلامس ملفًا واحدًا فقط، استخدم محرر GitHub المستند إلى الويب:
ابحث عن الملف في content/en-us/ وانقر فوق "تحرير هذا الملف" .
انقر فوق Fork هذا المستودع .
قم بإجراء التغييرات ثم انقر فوق تنفيذ التغييرات... .
قم بإعطاء التغيير الخاص بك رسالة التزام وصفية وانقر فوق اقتراح التغييرات .
تأكد من أن المستودع الأساسي هو Roblox/creator-docs وأن الفرع الأساسي هو main . تأكد من أنك راضٍ عن التغييرات التي أجريتها، ثم انقر فوق إنشاء طلب سحب .
أخيرًا، قم بملء التفاصيل في وصف طلب السحب وانقر فوق إنشاء طلب سحب .
بالنسبة للتغييرات الأكبر التي تتعلق بملفات متعددة، نوصي باستخدام github.dev، وهو محرر نصوص كامل الميزات يعتمد على Visual Studio Code الذي يتم تشغيله في متصفحك:
شوكة المستودع.
أثناء تصفح الشوكة، اضغط على . مفتاح لفتح github.dev.
في قائمة التحكم بالمصدر ، انقر فوق ... > فرع > إنشاء فرع... .
قم بتسمية الفرع وانقر فوق "التبديل إلى الفرع" .
استخدم قائمة Explorer للعثور على الملفات التي تريد تحديثها في content/en-us ، وقم بإجراء التغييرات المطلوبة.
في قائمة التحكم بالمصدر ، تأكد من أنك راضٍ عن التغييرات التي أجريتها.
أضف رسالة التزام وانقر فوق Commit & Push .
في علامة تبويب المتصفح الجديدة، انتقل إلى github.com/Roblox/creator-docs.
انقر فوق مقارنة وسحب الطلب .
تأكد من أن المستودع الأساسي هو Roblox/creator-docs وأن الفرع الأساسي هو main . يجب أن يكون مستودع الرأس هو شوكتك وفرعك.
أخيرًا، قم بملء التفاصيل في وصف طلب السحب وانقر فوق إنشاء طلب سحب .
وبدلاً من ذلك، يمكنك استخدام قوائم GitHub أو GitHub Pull Request في github.dev لإرسال طلب السحب. للحصول على وثائق حول استخدام github.dev، راجع GitHub Codespaces.
هذا المستودع كبير للغاية، لذا نوصي باستخدام الخيارات عبر الإنترنت كلما أمكن ذلك. ومع ذلك، إذا كنت على دراية بسير عمل GitHub العام وترغب في استخدام محرر نصوص غير متصل بالإنترنت، فإليك الخطوات الأساسية للمساهمة في التوثيق:
قم بإعداد Git وGit LFS. وبدلاً من ذلك، قم بتثبيت عميل Git مثل GitHub Desktop.
شوكة هذا المستودع.
استنساخ شوكة الخاص بك.
انتقل إلى جذر المستودع.
إنشاء فرع جديد.
قم بإجراء التغييرات المطلوبة.
التزم، وادفع إلى مفترقك، وأرسل طلب السحب الخاص بك إلى الفرع main لهذا المستودع.
لمزيد من الخطوات التفصيلية، راجع CONTRIBUTING.md.
تحتوي وثائق Roblox على ثلاثة أنواع رئيسية من المستندات:
أدلة مفاهيمية وقائمة على المهام في ملفات .md في content/en-us/
تعلمك الأدلة عن ميزة أو سير عمل دون الإفراط في التوجيه بشأن النتيجة النهائية. إنها تقدم المفاهيم والميزات وتغطي المهام التي يمكنك إنجازها باستخدام أدوات متنوعة أو أساليب أخرى.
تستفيد الأدلة بشكل كبير من حالات الاستخدام العملية والواقعية والصور ومقتطفات التعليمات البرمجية والرسوم البيانية. يجب أن يتضمن معظم المحتوى المستند إلى المهام قائمة مرقمة.
مستندات API المرجعية في ملفات .yaml في content/en-us/reference
تعد واجهات برمجة التطبيقات (APIs) محتوى مرجعيًا بالكامل ويجب أن تستخدم الأوصاف الوظيفية، مع الارتباط بالأدلة عند الاقتضاء. أكثر من أنواع المحتوى الأخرى، يجب أن يكون المحتوى المرجعي مقتضبًا ومباشرًا؛ لا يلزم أن تكون ملخصات الخصائص والأساليب والأحداث وعمليات الاسترجاعات جملًا كاملة.
البرامج التعليمية في ملفات .md في content/en-us/tutorials
بالمقارنة مع الأدلة المستندة إلى المهام، تعد البرامج التعليمية أكثر استقلالية وتنقلك من لا شيء إلى شيء ما . هذا التركيز على إنشاء شيء محدد يعني أنهم عادةً ما يكونون أكثر توجيهًا من الأدلة. غالبًا ما تتطرق البرامج التعليمية إلى ميزات ومفاهيم متعددة في نفس الوقت، مما يوضح الروابط بين الأدوات والاستراتيجيات.
إذا كانت مساهمتك لا تندرج ضمن هذه الفئات أو تغطي موضوعًا ضيقًا بشكل خاص، فقد لا تكون مناسبة للتوثيق. فكر في نشره في منتدى مطوري Roblox.
حاول قصر تعديلاتك على فئة أو ميزة واحدة حتى يسهل مراجعة طلب السحب. إصلاحات الأخطاء والتحسينات الأصغر لها احتمالية أكبر للموافقة السريعة. غالبًا ما تتطلب الأدلة الكبيرة عددًا كبيرًا من الرسائل ذهابًا وإيابًا قبل النشر.
لتجنب مشكلات التنسيق، نوصي باستخدام برامج تحرير النصوص مثل github.dev التي تتيح لك معاينة Markdown أثناء كتابته. بالنسبة للنثر، حاول اتباع الإرشادات الموجودة في STYLE.md. للحصول على نماذج التعليمات البرمجية، استخدم دليل نمط Lua.
لعرض صفحة منسقة بالكامل وفقًا لما نراه في الفرع main ، استبدل عنوان URL بالكامل من content/ وما قبله. يجب إزالة هذا الاسم من الملفات التي تحتوي على index الاسم الأساسي. على سبيل المثال، يتم عرض صفحة "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" على "https://create.roblox.com" /docs/en-us/avatar".
بالنسبة للنثر، يستخدم هذا المشروع رخصة المشاع الإبداعي 4.0 الدولية العامة. للحصول على نص الترخيص الكامل، راجع الترخيص.
تتوفر نماذج التعليمات البرمجية بموجب ترخيص MIT. للحصول على نص الترخيص الكامل، راجع رمز الترخيص.
للحفاظ على مجتمع مفتوح ومرحب ومتنوع وشامل وصحي، يفرض هذا المشروع نسخة معدلة من ميثاق المساهمين. لمزيد من المعلومات، راجع CODE_OF_CONDUCT.md.
