貢獻指南
本頁說明如何申請圖示、回報圖示問題和貢獻圖稿。
申請圖示
開啟圖示申請,說明圖示的用途、代表它的日常物品,以及懸停動態。物品明確的申請會優先繪製。
回報圖示問題
若要回報問題,例如可見的接縫、小尺寸下模糊的標記或動態不正確,請開啟圖示問題並附上螢幕截圖。
提交圖示
如果你用 Skill 或手動繪製了圖示,但不想開 pull request,請使用提交頁面。它會在瀏覽器中檢查你的檔案,並準備好 GitHub issue。在你送出 issue 之前,檔案只會留在瀏覽器中。
將圖稿匯出為 SVG。使用 Skill 時,請執行 node scripts/export.mjs。靜態 SVG 即可:圖示通過審核後,會在審查期間加入動態。若要提出自己設計的動態,請附上圖示的原始檔。
維護者會依設計規範,對照議題中貼出的預覽圖逐一審查每項提交。標誌、商標以及描摹自其他圖示集的內容無法收錄。通過審核的圖示會以 MIT 授權收錄到圖示庫,並標示你的署名。
若要讓程式開發 Agent 代為提交圖示,請將以下提示詞貼給它。Agent 會請你確認條款,然後用 GitHub CLI 發出 issue:
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 換成你的圖示名稱:
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 testtools/check.mjs 會產生比對圖,也就是將你的圖示與 --with 所列的現有圖示並排的預覽圖。請將比對圖附在 pull request 中。CI 會重新渲染有變更的圖示並執行測試,維護者會審查圖示與整套風格是否協調。
授權條款
貢獻的圖示和套件程式碼以 MIT 授權發布。網站和 Skill 的變更遵循各自的條款,列於授權條款頁面。