コントリビュート

アイコンをリクエストする

アイコンのリクエストを作成し、アイコンの用途、それを表す身近なモノ、ホバー時のモーションを書いてください。表すモノがはっきりしているリクエストから先に描かれます。

アイコンの不具合を報告する

目に見える継ぎ目、小さいサイズでのぼやけたマーク、誤ったモーションなどの問題を報告するには、アイコンのバグを作成し、スクリーンショットを添付してください。

アイコンを投稿する

Skill または手作業でアイコンを描き、プルリクエストを出したくない場合は、投稿ページを使ってください。ブラウザー内でファイルを確認し、GitHub のイシューを準備します。ファイルは、イシューを投稿するまでブラウザー内にとどまります。

描いたものを SVG として書き出します。Skill を使う場合は、node scripts/export.mjs を実行してください。静的な SVG で十分です。アイコンが採用された場合、モーションはレビューの際に追加されます。独自のモーションを提案する場合は、アイコンのソースファイルを追加してください。

メンテナーは、イシューに投稿されたプレビューを使って、各投稿をデザインルールに照らして目視で確認します。ロゴ、商標、他のアイコンセットからトレースしたものは受け付けられません。採用されたアイコンは MIT ライセンスのもとでライブラリに加わり、あなたのクレジットが記載されます。

コーディングエージェントにアイコンを投稿させるには、次のプロンプトをエージェントに貼り付けます。エージェントが利用条件の確認を求め、確認後に 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/ に、アイコンごとに 1 つの ES モジュールとして保存されています。Kubai Icons Skill または手作業で、PROMPT.md と docs/authoring.md に従って描いてください。作業内容を確認するには、下の my-icon をあなたのアイコン名に置き換えます。

tools/check.mjs はコンタクトシートを生成します。コンタクトシートとは、あなたのアイコンを、--with で指定した既存のアイコンと並べて表示するプレビュー画像です。プルリクエストに添付してください。CI は変更されたアイコンを再度レンダリングしてテストを実行し、メンテナーがアイコンがセットに合っているかを確認します。

ライセンス

投稿されたアイコンとパッケージのコードは MIT ライセンスで公開されます。ウェブサイトと Skill への変更には、ライセンスページに記載されている独自の条件が適用されます。