Contribuição

Esta página descreve como solicitar um ícone, relatar um bug de ícone e contribuir com um desenho.

Solicitar um ícone

Abra uma solicitação de ícone informando para que o ícone serve, o objeto do dia a dia que o representa e o movimento ao passar o cursor. As solicitações com um objeto claro são desenhadas primeiro.

Relatar um bug de ícone

Para relatar um problema, como emendas visíveis, marcas borradas em tamanhos pequenos ou movimento incorreto, abra um bug de ícone e anexe uma captura de tela.

Enviar um ícone

Se você desenhou um ícone com a Skill ou à mão e não quer abrir um pull request, use a página de envio. Ela verifica seus arquivos no navegador e prepara uma issue no GitHub. Os arquivos ficam no navegador até você publicar a issue.

Exporte o desenho como SVG. Com a Skill, execute node scripts/export.mjs. Um SVG estático basta: se o ícone for aceito, o movimento é adicionado durante a revisão. Para propor seu próprio movimento, inclua o arquivo de origem do ícone.

Um mantenedor avalia cada envio a olho nu, com base nas regras de design, usando uma pré-visualização publicada na issue. Logotipos, marcas registradas e qualquer coisa decalcada de outro conjunto de ícones não podem ser aceitos. Os ícones aceitos entram na biblioteca sob a Licença MIT, com crédito para você.

Para que um agente de programação envie o ícone, cole este prompt nele. O Agent pede que você confirme os termos e depois publica a issue com a CLI do GitHub:

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.

Desenhar um ícone

Os ícones ficam em icons/, um módulo ES por ícone. Desenhe-os com a Skill Kubai Icons ou à mão, seguindo PROMPT.md e docs/authoring.md. Para conferir seu trabalho, substitua my-icon abaixo pelo nome do seu ícone:

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 gera folhas de contato, que são imagens de pré-visualização mostrando seu ícone ao lado dos ícones existentes listados em --with. Anexe-as ao seu pull request. A CI renderiza de novo os ícones alterados e executa os testes, e um mantenedor avalia o quanto o ícone combina com o conjunto.

Licença

Os ícones contribuídos e o código dos pacotes são publicados sob a Licença MIT. As alterações no site e na Skill seguem termos próprios, listados na página Licença.

Kubai Icons é de uso gratuito. Apoie o projeto