ابدأ بنوع المساعدة التي تحتاجها مستودعاتك
يمكن أن تركز مراجعة تواجد GitHub على النصائح أو تحسين النصوص أو دعم الوثائق. نتفق أولاً على المستودعات المهمة. نتفق أيضًا على ما تريد أن يفهمه الزائر.
تحتاج بعض الفرق إلى نظرة جديدة على المواد العامة. بينما وجدت فرق أخرى الفجوات بالفعل وتريد مساعدة في جعل الوثائق أسهل في المتابعة. يساعدك الجدول في وصف نقطة البداية. يمكن أن يجمع العمل بين هذه الخيارات عندما يكون ذلك منطقيًا.
| نقطة البداية | ما ننظر إليه | ما يمكنك توقعه |
|---|---|---|
| مراجعة | أوصاف المستودعات ومحتوى README والروابط والإرشادات المرئية | قائمة مرتبة بالتغييرات والمسؤولين المقترحين |
| دعم النصوص | النصوص الموجهة للمشروع التي حددها فريقك | نصوص منقحة أو مكتوبة للمراجعة الفنية |
| دعم الوثائق | إرشادات الإعداد ومعلومات المساهمة والمواد ذات الصلة | هيكل أوضح وتعديلات وثائق متفق عليها |
لكل مستودع، نبحث عن الخطوة المفيدة التالية للقارئ. يجب أن يفهم المشروع أو يجد الوثائق ذات الصلة أو يتعلم كيفية طرح سؤال. نلاحظ الحقائق التقنية المفقودة بدلاً من ملء الفجوات بالتخمينات. يؤكد جهة الاتصال المطورة لديك تفاصيل المنتج قبل نشر أي شيء.
إذا كان مجتمعك العام بحاجة إلى انتقال أوضح من المواد التقنية، يمكننا أيضًا ربط هذا العمل بـ نمو المجتمع والتعاقد. الهدف هو مسار عملي بين المستودع والمكان الذي يجيب فيه فريقك فعليًا على الأسئلة.
اجعل المشروع أسهل في المتابعة قبل وصول الاهتمام
معلومات المستودع الواضحة تمنح الزوار مكانًا مفيدًا للبدء عندما يُناقش المشروع. يمكن لمراجعة قصيرة أن تساعد فريقك في اكتشاف الروابط المربكة والسياق المفقود والأوصاف القديمة. يمكنك القيام بذلك قبل مشاركة تلك المواد على نطاق أوسع.
تخيل مدير العمليات في مشروع توكن ناشئ، في المساء الذي يسبق AMA. يلاحظ أن رابط المشروع يفتح مستودعًا بدون نقطة بداية واضحة. سنتحقق من المسار العام ونحدد ما يحتاجه الوافد الجديد أولاً. ثم نطلب من جهة الاتصال الفنية تأكيد الصياغة.
هذا النوع من المراجعة يتعلق بالجاهزية، وليس إضافة نشاط لذاته. ننظر إلى ما يمكن للشخص رؤيته. نأخذ أيضًا في الاعتبار ما يمكن للفريق الحفاظ عليه بدقة. قد تكون النتيجة فتح README أكثر فائدة أو دليل إعداد في مكان أفضل أو مسار أوضح لطرح الأسئلة الفنية.
لنفترض أن مشروعك يحتوي على مستودعين: واحد لأداة وآخر للأمثلة. قد لا تشرح أوصافهما كيفية ارتباطهما. نحدد العلاقة ونقترح أين ينتمي الشرح. يقرر فريقك ما إذا كان سيجري التعديل. يتحقق المالك الفني منه أولاً.
عندما تحتاج أسئلة المجتمع إلى منزل خارج GitHub، يمكن لـ إدارة المجتمع والإشراف دعم جانب المحادثة. نبقي إرشادات المستودع ومسار المجتمع مختلفين، بحيث يخدم كل منهما غرضًا واضحًا.
ما الذي يجب أن يتمكن المساهم الجديد من استنتاجه؟
يجب أن يتمكن المساهم الجديد من فهم المشروع والعثور على التعليمات ذات الصلة ورؤية كيفية اتخاذ خطوة معقولة تالية. نراجع تلك الخطوات كما سيفعل الزائر. ثم نفصل المعلومات المفقودة عن المعلومات التي تحتاج ببساطة إلى مكان أفضل.
ابدأ بشرح بسيط
يجب أن يجعل المستودع غرضه وجمهوره سهلين في الفهم. نتحقق من أن الوصف وملف README يستخدمان المصطلحات بشكل متسق. نتحقق أيضًا من أنهما يشيران إلى مواد المشروع الحالية. إذا كان سياق المنتج غير واضح، نطلب من فريقك الحقائق بدلاً من إضافة افتراضات.
اجعل الإجراء الأول مرئيًا
يجب أن تظهر تعليمات البدء ما يحتاجه الشخص قبل تجربة المشروع. يجب أن تعكس إرشادات المساهمة العملية التي يمكن لفريقك دعمها فعليًا. قد تكون الخطوة التالية المفيدة طريقة موثقة لطرح سؤال أو اقتراح تغيير. نؤكد هذا المسار معك.
حافظ على وضوح التسليم
إذا احتاج شخص ما إلى مساعدة، فلا ينبغي أن يضطر إلى تخمين القناة التي تتم مراقبتها. يمكننا ربط إرشادات المستودع بـ خطة تنشيط المجتمع الخاصة بك، مع الحفاظ على الوثائق الفنية كمرجع للتفاصيل التقنية.
قبل المراجعة، اجمع تعليمات الإعداد الحالية والجمهور المستهدف لكل مستودع. حدد أيضًا جهة اتصال يمكنها التحقق من الادعاءات الفنية. على سبيل المثال، يمكن للفريق توجيهنا إلى وصف المنتج المفضل وقناة الدعم. يمنحنا ذلك أساسًا سليمًا لاكتشاف اللغة غير المتسقة وعمليات التسليم غير الواضحة.
ثلاث نقاط تفتيش تنقل العمل من الروابط إلى التغييرات القابلة للاستخدام
تنتقل المراجعة عبر ثلاث نقاط تفتيش: فهم المشروع، وفحص المواد العامة، وتسليم الإجراءات المتفق عليها. نبقي العمل مركزًا على المستودعات والجماهير التي تحددها.
- شارك نقطة البداية. أرسل روابط المستودعات ووصفًا قصيرًا للمنتج والأشخاص الذين تريد أن تخدمهم المواد. اذكر أي مناطق خاصة أو حساسة يجب أن تبقى خارج المراجعة.
- اتفق على ما سنتحقق منه. نؤكد المستودعات والوثائق. نؤكد أيضًا ما إذا كنت بحاجة إلى توصيات أو دعم في النصوص، ومن يمكنه التحقق من المعلومات الفنية.
- راجع مسار الزائر. ننظر إلى أوصاف المستودعات ومحتوى README وروابط الوثائق وإرشادات المساهمة. يتم تجميع النتائج حسب ما يحتاجه القارئ ومن يمكنه التصرف بناءً على كل عنصر.
- تحقق من الحقائق معًا. تراجع جهة الاتصال الفنية لديك الصياغة المقترحة وتؤكد أي التفاصيل دقيقة. نترك ادعاءات سلوك المنتج وتنفيذه لفريقك للتحقق.
- سلم العمل. تتلقى قائمة الإجراءات المتفق عليها وأي دعم في النصوص أو الوثائق المضمنة، مع توضيح الملكية.
نحدد التوقيت بعد رؤية عدد المستودعات وكمية المواد المعنية. يساعد وجود جهة اتصال واحدة محددة من جانبك في الحفاظ على تقدم الأسئلة الفنية. إذا كان مشروعك يستخدم أيضًا نمو مجتمع Telegram أو نمو مجتمع Discord، شارك تلك الوجهات. يمكننا بعد ذلك التحقق من كيفية توجيه GitHub للزوار إليها.
حافظ على فائدة المواد العامة بعد المراجعة
يتطلب تواجد GitHub الواضح مالكًا بعد المراجعة. يمكن أن تتغير تفاصيل المستودع والوثائق مع المنتج. نساعد فريقك على المغادرة بإجراءات عملية تالية، وليس بقائمة تعتمد على دعم خارجي مستمر.
لكل تغيير متفق عليه، حدد مالكًا واحدًا والمكان الذي ينتمي إليه التحديث. تحتاج التعليمات الفنية إلى مطور لتأكيدها. تحتاج أوصاف المشروع والروابط إلى شخص يمكنه الحفاظ على تحديثها. يمكن أن يسأل فحص بسيط عما إذا كان ملف README لا يزال متوافقًا مع المنتج. يمكنه أيضًا التحقق من أن الروابط الرئيسية تعمل. ثم تأكد من أن إرشادات المساهمة تعكس العملية التي يتبعها فريقك.
يمكننا مراجعة المواد العامة ودعم أعمال الوثائق المتفق عليها. يتحكم فريقك في الوصول إلى المستودع وقرارات النشر والتفاصيل الحساسة للأمان والصيانة المستمرة. احتفظ ببيانات الاعتماد الخاصة ومعلومات التنفيذ الحساسة خارج الملفات العامة. اطلب من المالك الفني المناسب الموافقة على التغييرات قبل النشر.
يتحكم GitHub في كيفية عرض أو إظهار المستودعات. يقرر الزوار ما إذا كانوا سيقرؤون أو يشاركون أو يساهمون. نلتزم بالمراجعة والمواد المتفق عليها معك، وليس بظهور المنصة أو المشاركة الخارجية.
إذا كنت مستعدًا للبدء، أرسل لنا روابط المستودعات ووصفًا قصيرًا للمشروع والجمهور الذي تريد الوصول إليه. سنراجع نقطة البداية معك ونؤكد الحدود ونتفق على الخطوات التالية.
كيف نعمل
- شارك سياق المشروعأرسل روابط المستودعات ووصفًا قصيرًا للمنتج والجمهور الذي تريد الوصول إليه. لاحظ أي معلومات يجب أن تظل خاصة.
- اتفق على حدود المراجعةنؤكد المستودعات والوثائق التي يجب فحصها ونوع الدعم الذي تحتاجه ومن يمكنه التحقق من التفاصيل الفنية.
- راجع النتائج ونظمهاننظر إلى التجربة العامة ونرتب الإجراءات العملية حسب حاجة القارئ والملكية.
- تحقق من الصياغة الفنيةتؤكد جهة الاتصال الفنية لديك التفاصيل المقترحة قبل أن ينشرها فريقك أو يستخدمها.
- استلم العمل المتفق عليهنسلم الإجراءات ذات الأولوية وأي دعم في النصوص أو الوثائق المضمنة.
الأسئلة الشائعة
ما هي روابط GitHub التي يجب أن أرسلها أولاً؟
ابدأ بالمستودعات التي تريد أن يفهمها الناس أو يستخدموها. ثم أضف وصفًا قصيرًا للمنتج والجمهور الذي في ذهنك. قم بتضمين روابط الوثائق أو المجتمع التي يجب أن تشير إليها تلك المستودعات. ستساعدنا جهة اتصال فنية واحدة يمكنها تأكيد التفاصيل في الحفاظ على دقة التوصيات.
هل يمكنك تحسين ملف README دون تغيير الكود الخاص بنا؟
نعم. إذا كان دعم النصوص جزءًا مما نتفق عليه، يمكننا مراجعة أو إعداد نص README دون تغيير كود المستودع. تتحقق جهة الاتصال الفنية لديك من تعليمات الإعداد وادعاءات المنتج قبل النشر. للمرة الأولى، أخبرنا بأي مستودع هو الأكثر أهمية وما يجب أن يفهمه الزائر هناك.
هل يمكنك مراجعة عدة مستودعات معًا؟
نعم. يمكننا النظر في مستودع واحد ذي أولوية أو عدة مستودعات ذات صلة. بالنسبة للمستودعات المتعددة، أخبرنا أيها نشط وكيف ترتبط بالمنتج. يساعدنا هذا السياق في التحقق مما إذا كانت الأوصاف والروابط ترشد القراء بينها دون تكرار أو تناقض.
ماذا لو كانت وثائقنا الفنية لا تزال تتغير؟
يمكننا مراجعة المسار العام وملاحظة التفاصيل التي تحتاج إلى تأكيد. لن نتعامل مع المواد غير المكتملة على أنها نهائية. يمكن لفريقك تحديد مصدر حالي للحقائق المتعلقة بالمنتج وتسمية مالك للفحوصات الفنية. يمنحنا ذلك طريقة لتحسين الهيكل مع ترك الادعاءات غير المؤكدة دون نشر.
كيف تقرر ما الذي ستعمل عليه أولاً؟
ننظم النتائج حول ما يحتاج القارئ إلى فهمه أو فعله. ثم نحدد من يمكنه إجراء كل تغيير. قد يستحق المسار المكسور إلى الإرشادات الرئيسية أو غرض المستودع غير الواضح الاهتمام قبل تحسين الصياغة. أنت وجهة الاتصال الفنية لديك تؤكدان الترتيب وفقًا لأولويات المشروع الحالية.
هل يمكن لمراجعة GitHub أن تجعل المستودع يظهر أكثر؟
لا يمكن لأي مراجعة التحكم في كيفية عرض GitHub للمستودعات أو إظهارها، أو ما إذا كان الزوار يختارون المساهمة. يمكننا تقديم المراجعة المتفق عليها وعمل الوثائق، ثم جعل المواد العامة أكثر وضوحًا للأشخاص الذين يصلون. على سبيل المثال، يمكننا المساعدة في توضيح غرض ملف README وجعل مسار المساهمة الحالي أسهل في العثور عليه.
أخبرنا عن مشروعك
أجب عن أربعة أسئلة سريعة وسيرسل لك مدير الحساب خلال ساعة خطة وجدولا زمنيا ونطاقا للميزانية. كل شيء يبقى سريا.
جار تحميل النموذج…