PopClip Extensions

La documentation du développeur a évolué! Voir https://www.popclip.app/dev/ pour les derniers documents.

---

Extensions popclip

Ce référentiel contient les fichiers source pour bon nombre des extensions publiées dans le répertoire d'extensions POPCLIP officiel.

Mise en page du référentiel

Les dossiers principaux:

• source - Sources pour les extensions publiées (maintenu et soutenu par moi)
• contrib - Dossier pour les extensions non publiées / contribuées / expérimentales / niche / archivées (non entretenues ou soutenues)

Contributif

Les corrections et les améliorations des extensions existantes sont les bienvenues via la demande de traction.

Pour contribuer de nouvelles extensions au répertoire, la manière préférée est de la soumettre directement au serveur d'annuaire à partir de votre propre référentiel. La page du répertoire de l'extension sera liée à votre dépôt et vous maintiendrez et metrez à jour l'extension vous-même. Contactez-moi à Mailto: [email protected] pour les instructions de soumission.

Alternativement, de nouvelles extensions peuvent être soumises par demande de traction dans le dossier contrib de ce dépôt. (Si je le publie, je le déplacerai moi-même vers le dossier source .)

Lignes directrices de qualité

Veuillez noter que je ne publierai pas toutes les soumissions. Les extensions à publier doivent être de haute qualité et répondre aux critères suivants:

• L'extension a un objectif unique et utile à un public général.
• L'extension "fonctionne juste", avec une configuration minimale par l'utilisateur.
• Un nom bien choisi, conformément au style de dénomination d'autres extensions. Les noms sont généralement un ou deux mots; Par exemple ✅ "Instapaper", et non "Envoyer à Instapaper"; ✅ "majuscules" non "Convertir en majuscules".
• Une bonne icône, représentant clairement l'action. (Utilisez des symboles iconify ou SF si vous n'êtes pas concepteur.)
• Dans la configuration, une description claire et concise à une phrase de ce que fait l'extension. C'est ce qui apparaît sur le site Web à côté du nom d'extension.
• Outre les extensions les plus simples, incluez un fichier readme.md expliquant brièvement comment utiliser l'extension, en mentionnant en particulier les fonctionnalités spéciales et les options de configuration. Ajoutez un Changelog au bas de la lecture.
• Lorsque les clés API sont nécessaires, cela doit être clairement documenté dans le ReadMe avec des instructions et un lien pour obtenir la clé.
• Pas de scripts inutiles. Par exemple, n'utilisez pas un script bash pour ouvrir une URL lorsque vous pouvez simplement utiliser l'action url .
• Favoriser les actions JavaScript sur le script shell ou les actions Applescript à moins que l'action particulière ne soit vraiment un script shell ou un pommes.
• Les extensions de script shell doivent fonctionner prêtes à l'emploi sur une installation par défaut des dernières macOS. Je ne publierai pas d'extensions qui obligent l'utilisateur à installer des langages ou des bibliothèques de scripts supplémentaires.
• Utilisez le ReadMe pour vous rendre hommage en tant qu'auteur et reconnaître tous les autres contributeurs, bibliothèques open source ou créateurs d'icônes.
• Pas de binaires compilés. Toutes les soumissions doivent être uniquement du code source.
• Les extensions qui interagissent avec un site Web ou une application doivent avoir un dictionnaire app dans la configuration, en définissant les champs name et link . Le nom sera automatiquement lié dans la description de l'extension.
• Pour les extensions qui fonctionnent avec une application MacOS tierce, la clé bundleIdentifiers avec l'option checkInstalled: true doit également être utilisée.
• Aucune extension visant à contourner le droit d'auteur, à vaincre les murs de paie, etc.
• Aucun lien vers des sites de torrent / de fichiers qui indexent principalement le contenu protégé par le droit d'auteur.
• Rien de ce que les «téléphones à la maison», collecte les données de l'utilisateur ou modifie le système de l'utilisateur de quelque manière que ce soit.
• Rien d'illégal ou de nocif ni que vous ne montreriez pas à votre grand-mère.
• La liste ci-dessus n'est pas exhaustive et je me réserve le droit de rejeter une soumission pour toute autre raison.

Avec tout cela dit ... veuillez soumettre votre extension! J'ai hâte de voir ce que vous proposez.

Crédits

Les crédits sont inclus dans les fichiers de lecture de l'extension individuelle.

Licence

Tout le code source est publié dans le cadre de la licence MIT (licence.txt), sauf indication contraire dans les fichiers de lecture d'extension.

Changelog

Les modifications individuelles sont incluses dans les fichiers de readme d'extension.