Участие в проекте

На этой странице описано, как запросить иконку, сообщить об ошибке в иконке и предложить свой рисунок.

Запросить иконку

Создайте запрос на иконку, где укажите, для чего она нужна, какой предмет из обычной жизни её обозначает и какая у неё анимация при наведении. Запросы с понятным предметом рисуются в первую очередь.

Сообщить об ошибке в иконке

Чтобы сообщить о проблеме, например о видимых швах, размытых знаках при малых размерах или неверной анимации, создайте issue об ошибке иконки и приложите снимок экрана.

Предложить иконку

Если вы нарисовали иконку с помощью Skill или вручную и не хотите открывать пулл-реквест, воспользуйтесь страницей отправки. Она проверяет ваши файлы в браузере и готовит issue на GitHub. Файлы остаются в браузере, пока вы не опубликуете issue.

Экспортируйте рисунок в SVG. С помощью Skill выполните node scripts/export.mjs. Достаточно статичного SVG: если иконку примут, анимацию добавят при проверке. Чтобы предложить свою анимацию, приложите исходный файл иконки.

Мейнтейнер проверяет каждую заявку на соответствие правилам дизайна, используя превью, опубликованное в issue. Логотипы, товарные знаки и всё, что перерисовано с другого набора иконок, принять нельзя. Принятые иконки входят в библиотеку под лицензией MIT с указанием вашего авторства.

Чтобы AI-агент отправил иконку сам, вставьте в него этот промпт. Agent попросит подтвердить условия, а затем опубликует issue через GitHub CLI:

Submit my icon to the Kubai Icons library:
1. Export it as an SVG by running node scripts/export.mjs --only <name> in the skill folder.
2. Ask me to confirm that I made it, that it contains no logos or copied artwork, and that I agree to publish it under the MIT License. Stop if I do not confirm.
3. Run gh issue create --repo kubai087/kubai-icons --title "[Icon submission] <name>" with a body using these headings: "### Name" (kebab-case), "### What it does on hover" and "### Files" (the SVG in a code block, plus the icon's .js source if there is one).
4. Tell me the issue link.

Нарисовать иконку

Иконки хранятся в icons/, по одному ES-модулю на иконку. Рисуйте их с помощью Kubai Icons Skill или вручную, следуя PROMPT.md и docs/authoring.md. Чтобы проверить работу, замените my-icon ниже на название своей иконки:

bash

git clone https://github.com/kubai087/kubai-icons
cd kubai-icons && npm install
node tools/check.mjs --only my-icon --with folder,mail   # contact sheets in check-out/lib
npm run validate                                          # names, metadata, markup
npm run build:packages
npm test

tools/check.mjs создаёт контрольные листы: изображения, на которых ваша иконка показана рядом с существующими иконками, указанными в --with. Приложите их к пулл-реквесту. CI заново отрисовывает изменённые иконки и запускает тесты, а мейнтейнер оценивает, насколько иконка подходит набору.

Лицензия

Добавленные иконки и код пакетов распространяются под лицензией MIT. Изменения сайта и Skill подчиняются собственным условиям, перечисленным на странице Лицензия.