参与贡献

本页说明如何申请图标、报告图标问题,以及贡献自己绘制的图标

申请图标

请提交图标申请,说明图标的用途、代表它的日常物品,以及它的悬停动效。我们优先处理物品明确的申请。

报告图标问题

如果发现接缝外露、小尺寸下内部图形模糊或动效不正确等问题,请提交图标问题报告,并附上截图。

提交图标

如果你用 Skill 或手工绘制了图标,又不想发起 Pull Request(PR),可以使用提交页面。该页面在浏览器中检查文件,并生成 GitHub Issue。发布 Issue 之前,文件不会上传。

请将图标导出为 SVG。使用 Skill 时,运行 node scripts/export.mjs。仅提交静态 SVG 即可,图标通过审核后由维护者补充动效。如需提供自己的动效,请附上图标的源文件。

维护者依据设计规则,通过 Issue 中的预览图逐一人工审核。徽标、商标以及任何描摹自其他图标集的内容都不予接受。通过审核的图标将依据 MIT 许可证收入图标库,并为提交者署名。

如需由编程智能体提交图标,请将以下提示词粘贴到智能体的输入框中。智能体会先请你确认条款,再通过 GitHub CLI 发布 Issue:

把我绘制的图标提交到 Kubai Icons 图标库:
1. 在 Skill 目录中运行 node scripts/export.mjs --only <图标名>,导出 SVG。
2. 请我确认:图标由我绘制,不含徽标或抄袭的内容,并同意以 MIT 许可证发布。未确认则停止。
3. 运行 gh issue create --repo kubai087/kubai-icons --title "[Icon submission] <name>",正文使用这些标题:"### Name"(短横线连接的小写英文)、"### What it does on hover"、"### Files"(用代码块放入 SVG,如有 .js 源文件也一并放入)。
4. 告诉我 Issue 链接。

绘制图标

图标存放在 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 列出的现有图标并排展示的预览图。请将对比图附在PR中。CI 会重新渲染改动过的图标并运行测试,维护者则审核图标与整套图标是否协调。

许可证

贡献的图标和软件包代码均以 MIT 许可证发布。对网站和 Skill 的改动遵循各自的条款,详见许可证页面。

Kubai Icons 免费使用。 赞助本项目