Документация по разработчику переместилась! См. Https://www.popclip.app/dev/ для последних документов.
Расширения POPCLIP
Этот репозиторий содержит исходные файлы для многих расширений, опубликованных в официальном каталоге расширений PopClip.
Макет репозитория
Основные папки:
-
source - Источники опубликованных расширений (поддерживаются и поддерживаются мной) -
contrib - Папка для неопубликованных / пользовательских / экспериментальных / нишевых / архивированных расширений (не поддерживается или не поддерживается)
Внося
Исправления и улучшения существующих расширений приветствуются с помощью запроса на вытяжение.
Чтобы внести новые расширения в каталог, предпочтительным способом вы можете отправить его непосредственно на сервер каталогов из собственного репо. Страница каталогов расширения будет связана с вашим репо, и вы будете поддерживать и обновлять расширение самостоятельно. Свяжитесь со мной по адресу mailto: [email protected] для инструкций по заявлению.
В качестве альтернативы, новые расширения могут быть представлены с помощью запроса на притяжение в папке contrib в этом репо. (Если я опубликую его, я сам перенесю в папку source .)
Рекомендации по качеству
Обратите внимание, что я не буду публиковать все представления. Расширения, которые должны быть опубликованы, должны быть высокого качества и соответствовать следующим критериям:
- Расширение имеет четкую, единственную цель и полезно для широкой аудитории.
- Расширение «просто работает», с минимальной конфигурацией пользователем.
- Хорошо выбранное имя, в соответствии с стилем именования других расширений. Имена обычно одно или два слова; Например, ✅ «Instapaper», а не «отправить в Instapaper»; ✅ «Верхт» не «конвертируется в прописное».
- Хороший значок, четко представляющий действие. (Используйте символы Iconify или SF, если вы не дизайнер.)
- В конфигурации четкое, краткое, одно предложение
description того, что делает расширение. Это то, что появляется на веб -сайте рядом с именем расширения. - Помимо простых расширений, включите файл
readme.md , объясняющий кратко, как использовать расширение, в частности, упоминая любые специальные функции и параметры конфигурации. Добавьте изменение изменений в нижней части Readme. - Там, где необходимы клавиши API, это должно быть четко задокументировано в Readme с инструкциями и ссылкой для получения ключа.
- Нет бессмысленных сценариев. Например, не используйте сценарий BASH, чтобы открыть URL, когда вы можете просто использовать
url -действие. - Предполагайте действия JavaScript по сценарию Shell или AppleScript, если конкретное действие действительно не должно быть сценарием оболочки или AppleScript.
- Расширения сценариев оболочки должны работать без ящика при установке по умолчанию последних macOS. Я не буду публиковать расширения, которые требуют, чтобы пользователь установил дополнительные языки или библиотеки сценариев.
- Используйте Readme, чтобы отдать должное себе в качестве автора и признайте любых других участников, библиотеки с открытым исходным кодом или создателей значков.
- Нет составленных двоичных файлов. Все материалы должны быть только исходным кодом.
- Расширения, которые взаимодействуют с веб -сайтом или приложением, должны иметь словарь
app в конфигурации, определяя поля name и link . Имя будет автоматически связано в описании расширения. - Для расширений, которые работают с сторонним приложением MacOS, ключ
bundleIdentifiers с checkInstalled: true . - Никаких расширений, направленных на обход авторских прав, победы над платных выплатами и т. Д.
- Нет ссылок на сайты торрента / филиализации, которые в основном индексируют авторские права.
- Ничто, что «телефоны дома», собирает пользовательские данные или каким -либо образом изменяет систему пользователя.
- Ничего нелегального или вредного или что вы не покажете своей бабушке.
- Приведенный выше список не является исчерпывающим, и я оставляю за собой право отклонить подчинение по любой другой причине.
Со всем так сказано ... пожалуйста, отправьте свое продление! Я с нетерпением жду возможности увидеть то, что вы придумали.
Кредиты
Кредиты включены в индивидуальные файлы readme redtension.
Лицензия
Весь исходный код опубликован в соответствии с лицензией MIT (License.txt), если не указано иное в файлах Extension Readme.
Изменение
Индивидуальные изменчивы включены в файлы extension readme.