LibrePatch
سير العمل

البرمجيات مفتوحة المصدر: سرد التراخيص، ثم الإصلاح والاختبار

03
فحص الترخيص

سرد التبعيات وقراءة كل ترخيص قبل المساهمة

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

01

فتح المجلد

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

02

سرد الملفات

دع list_dir و glob يجدان ملفات التبعيات وملفات الترخيص، واقرأ قائمة النتائج التي يعرضها الوكيل في الدردشة. افتح أي بطاقة تبدو غير عادية، لأن البطاقة تعرض النتيجة الكاملة. لا يتم تعديل أي شيء في هذه الخطوة. خذ وقتك.

03

قراءة التراخيص

استخدم read_file و grep لقراءة نصوص التراخيص وخطوط SPDX، ولاحظ أي شيء لا تفهمه، حتى تتمكن من السؤال عن المشروع بشأنه. الكود بدون ترخيص، في معظم البلدان، لا يُسمح بإعادة استخدامه بحرية. أنت تقرأ فقط هنا، ولا تغير الملفات.

04

مراجعة النتيجة

راجع ملف CSV والفرق (diff)، ثم قارن كل سطر بنص الترخيص الخاص به وشغل اختبارات المشروع إذا كنت قد غيرت الملفات. اقبل فقط ما فهمته، ورفض الباقي. ثم أرسل المساهمة بنفسك، كما يطلب المشروع. احتفظ بنسخة من الجرد.

مثال على جرد التراخيص في ملف CSV

licenses.csv
package,version,licence,note
lib-a,1.0,MIT,keep notice
lib-b,2.0,BSD-3-Clause,keep notice
lib-c,1.5,Apache-2.0,keep notice
lib-d,3.0,MPL-2.0,share file changes
lib-e,1.2,GPL-3.0-only,share changes
lib-f,2.1,MIT,keep notice
lib-g,1.0,BSD-3-Clause,keep notice
lib-h,1.1,Apache-2.0,keep notice

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

جولة تفصيلية: قراءة التراخيص، إضافة رأس، تشغيل الاختبارات، المراجعة

استكشاف الكود والعثور على ملفات الترخيص

تبدأ بـ list_dir لرؤية هيكل المجلد و glob للعثور على ملفات LICENSE و COPYING وملفات التبعيات، ثم يبحث grep في ملفات المصدر عن خطوط SPDX. عادةً ما تذكر البرمجيات مفتوحة المصدر ترخيصها في هذه الأماكن الثلاثة، لذا فإن البحث يظهر ما يعلنه كل ملف وأي الملفات لا تعلن شيئًا. غالبًا ما يدرج مشرفو تطبيق تعليم مفتوح المصدر الميزات المطلوبة التالية في مشكلاتهم (Issues)، لذا اقرأها أيضًا قبل اختيار مهمة. اقرأ، لا تعدل. كل نتيجة هي بطاقة يمكنك توسيعها، وفي نهاية هذه الخطوة لديك قائمة بالملفات والتراخيص للتحقق منها، والتي تراجعها بعناية قبل الانتقال إلى الخطوة التالية. احفظ ملاحظاتك في ملف نصي حتى تتمكن من العودة إليها لاحقًا.

قراءة الترخيص وقواعد المساهمة

الآن يفتح read_file ملف LICENSE وملف CONTRIBUTING. يخبرك الترخيص بما يمكنك فعله بالكود، وتخبرك قواعد المساهمة بكيفية إرسال التغييرات إلى المشروع، لذا اقرأ كليهما تمامًا. مساهمتك الأولى في مفتوح المصدر أسهل في القبول عندما تتبع تلك القواعد تمامًا، لذا سجلها. يسأل بعض المساهمين عما إذا كان يجب مشاركة سجل جلسة كتابة التعليمات البرمجية بالذكاء الاصطناعي في العمل مفتوح المصدر؛ سياسة المشروع بشأن التغييرات التي تساعد فيها الذكاء الاصطناعي تجيب عن ذلك، وقد تطلب منك القول إن أداة ساعدت. شغل اختبارات المشروع الخاصة به مرة واحدة قبل تغيير أي شيء، حتى تعرف النتيجة الأولية. ثم راجع ملاحظاتك واكتب القواعد التي تنطبق على تغييرك. اقرأ أيضًا مدونة قواعد السلوك، إذا كان للمشروع واحدة، لأنها توضح السلوك المتوقع.

إضافة الرأس الذي يطلبه المشروع

تطلب بعض المشاريع رأس ترخيص قصير، على سبيل المثال خط SPDX، في أعلى كل ملف جديد. فقط عندما يقول ملف CONTRIBUTING أو LICENSE ذلك، تستخدم edit_file لإضافة ذلك الرأس بالضبط إلى ملفاتك الجديدة الثلاثة، وفي Ask first يظهر الوكيل الفرق (diff) قبل كتابة أي شيء. احتفظ بكل إشعار حقوق ملكية موجود ولا تغير ترخيصًا أبدًا. راجع الفرق سطراً بسطر. ثم استخدم grep لسرد الملفات التي لا تزال تفتقر إلى الرأس وشغل أمر اختبار المشروع، لأن رمز الخروج يخبرك ما إذا كان الأمر قد انتهى دون خطأ. إذا فشل اختبار، اقرأ المخرج قبل تغيير أي شيء آخر، واسأل المشروع عندما تكون قاعدة الرأس غير واضحة. استخدم نفس سطر الرأس في كل ملف.

التحقق من النتيجة قبل إرسالها

أخيرًا، يظهر grep الملفات التي تفتقر إلى الرأس، وتشغل Shell الاختبارات مرة أخرى وتبلغ عن رمز الخروج، وتقرأ الفرق (diff) بالكامل مرة أخرى. هذه 3 نتائج للمقارنة. يمكن أيضًا تشغيل أمر ماسح ثغرات الكود المصدري الذي تقدمه من خلال Shell؛ يعرض الوكيل مخرجاته وتقرر ما تعنيه، لكن لا يضمن المسح ولا الوكيل أن لا يوجد خطأ آخر. اكتب وصف طلب السحب (Pull Request)، واذكر الترخيص الذي قمت بفحصه والاختبارات التي قمت بتشغيلها، وأرسله بنفسك. اتبع قواعد المشروع. قد يطلب المراجعون تغييرات، وتتعامل معهم بنفس الطريقة: خطوة صغيرة، فرق، اختبار. انتظر إجابتهم قبل تغيير المزيد. اشكر المراجع عندما يساعدك، واحتفظ بكل إجابة قصيرة وودية، إصلاحًا واحدًا في كل مرة.

LibrePatch لنظام Windows

ابدأ أول سير عمل للترخيص الخاص بك

تحميل LibrePatch ↗