لقد تحركت وثائق المطور! انظر https://www.popclip.app/dev/ للحصول على أحدث المستندات.
ملحقات popclip
يحتوي هذا المستودع على ملفات المصدر للعديد من الامتدادات المنشورة في دليل ملحقات Popclip الرسمي.
تخطيط المستودع
المجلدات الرئيسية:
-
source - مصادر للملحقات المنشورة (التي تم صيانتها ودعمها من قبلي) -
contrib - مجلد للملحقات غير المنشورة / التي يتم توزيعها / تجريبي / متخصصة / أرشفة (غير محافظة أو مدعومة)
المساهمة
يتم الترحيب بالإصلاحات والتحسينات على الامتدادات الحالية عبر طلب السحب.
للمساهمة بملحقات جديدة في الدليل ، فإن الطريقة المفضلة هي أن ترسلها مباشرة إلى خادم الدليل من الريبو الخاص بك. سيتم ربط صفحة دليل الامتداد بإعادة الريبو الخاصة بك وستحتفظ بالتمديد وتحديثه بنفسك. اتصل بي على Mailto: [email protected] للحصول على تعليمات التقديم.
بدلاً من ذلك ، قد يتم تقديم امتدادات جديدة عن طريق طلب السحب في مجلد contrib لهذا الريبو. (إذا قمت بنشرها ، فسوف أنقلها إلى المجلد source بنفسي.)
إرشادات الجودة
يرجى ملاحظة أنني لن أنشر جميع الطلبات. يجب أن تكون الإضافات المراد نشرها ذات جودة عالية وتلبية المعايير التالية:
- الامتداد له غرض واحد واضح ، ومفيد للجمهور العام.
- امتداد "يعمل فقط" ، مع الحد الأدنى من التكوين من قبل المستخدم.
- اسم تم اختياره جيدًا ، تمشيا مع نمط التسمية للإضافات الأخرى. الأسماء عادة ما تكون كلمة واحدة أو كلمتين ؛ على سبيل المثال ✅ "Instapaper" ، وليس "إرسال إلى Instapaper" ؛ ✅ "الأحرف الكبيرة" وليس "تحويل إلى أقصى".
- رمز جيد ، يمثل بوضوح الإجراء. (استخدم رموز Iconify أو SF إذا لم تكن مصممًا.)
- في التكوين ،
description واضح وموجز ، واحد للالتحام لما يفعله الامتداد. هذا هو ما يظهر على الموقع بجوار اسم الامتداد. - بصرف النظر عن أبسط الامتدادات ، قم بتضمين ملف
readme.md يشرح بإيجاز كيفية استخدام الامتداد ، لا سيما ذكر أي ميزات خاصة وخيارات التكوين. أضف changelog في الجزء السفلي من ReadMe. - عند الحاجة إلى مفاتيح API ، يجب توثيق ذلك بوضوح في ReadMe مع التعليمات ورابط للحصول على المفتاح.
- لا توجد نصوص غير مجدية. على سبيل المثال ، لا تستخدم برنامج نصي Bash لفتح عنوان URL عندما يمكنك فقط استخدام إجراء
url . - تفضيل إجراءات JavaScript عبر إجراءات SHELL أو إجراءات Applescript ما لم يكن الإجراء المحدد حقًا نصًا أو ملفًا من shell.
- يجب أن تعمل ملحقات SHELL Script خارج الصندوق على تثبيت افتراضي لأحدث MACOS. لن أنشر ملحقات تتطلب من المستخدم تثبيت لغات نصية أو مكتبات إضافية.
- استخدم README لإعطاء الائتمان لنفسك كمؤلف وتعترف بأي مساهمين آخرين أو مكتبات مفتوحة المصدر أو منشئي الأيقونات.
- لا ثنائيات مجمعة. يجب أن تكون جميع التقديمات رمز المصدر فقط.
- يجب أن تحتوي الامتدادات التي تتفاعل مع موقع ويب أو تطبيق على قاموس
app في التكوين ، وتحديد حقول name link . سيتم ربط الاسم تلقائيًا في وصف الامتداد. - بالنسبة للإضافات التي تعمل مع تطبيق MacOS من طرف ثالث ، يجب أيضًا
bundleIdentifiers خيار checkInstalled: true أيضًا. - لا توجد ملحقات تهدف إلى التحايل على حقوق الطبع والنشر ، وهزيمة Paywalls وما إلى ذلك.
- لا توجد روابط لمواقع تورنت / مشاركة الفلزات التي في الغالب فهرسة المحتوى المحمي بحقوق الطبع والنشر.
- لا شيء "الهواتف الرئيسية" ، أو يجمع بيانات المستخدم ، أو يعدل نظام المستخدم بأي شكل من الأشكال.
- لا شيء غير قانوني أو ضار أو لن تظهر لجدتك.
- القائمة أعلاه ليست شاملة وأحتفظ بالحق في رفض التقديم لأي سبب آخر.
مع كل ما قال ... من فضلك أرسل ملحقك! أنا أتطلع إلى رؤية ما توصلت إليه.
الاعتمادات
يتم تضمين الاعتمادات في ملفات Extension Extension.
رخصة
يتم نشر جميع التعليمات البرمجية المصدر ضمن ترخيص MIT (الترخيص.
Changelog
يتم تضمين changelogs الفردية في ملفات Extension ReadMe.