conventions について
conventions は、Philtz の規約に沿ってコミットメッセージを検査する CLI です。リポジトリの `.vite-hooks/commit-msg` から呼び出され、ローカルの `.github/conventions.yml` を優先できます。
主な機能
- 01Philtz 規約に基づくメッセージ検査
- 02リポジトリ固有の規約ファイルに対応
- 03commit-msg フックから実行
- 04依存関係なし、Node 22 以上が必要
活用シーン
- 01コミット前のメッセージ形式検証
- 02リポジトリごとの規約適用
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ philtzjp/ skills --skill conventionsインストール後、Claude Code で/conventionsを入力して読み込まれたか確認します。
同梱ファイルcli.mjsconventions.yml
詳細
プロジェクトの README よりconventions
コミットメッセージを、Philtz の規約で検査する CLI です。各リポジトリの .vite-hooks/commit-msg が呼びます。
このスキルの中身は、philtzjp/organizer-bot の packages/conventions と、philtzjp/.github の conventions.yml から philtz-organizer-bot が写しています。ここを直接編集しないでください。次に写したときに上書きされます。
中身
cli.mjs: 検査器。依存がなく、Node 22 以上だけで動くconventions.yml: 規約。作業中のリポジトリに.github/conventions.ymlがあれば、そちらを優先する
hook から呼ぶ
#!/bin/sh
cli=.agents/skills/conventions/cli.mjs
if [ ! -f "$cli" ]; then
echo "書式の検査器がありません。AGENTS.md の手順でスキルを入れてください"
exit 1
fi
exec node "$cli" commit-msg "$1"
検査器がないときに黙って通すと、検査が効いているように見えて効いていない状態になります。止めて、スキルを入れる手順を出してください。
検査に落ちたとき
- 出たメッセージに従ってコミットメッセージを直す。書き方は github スキルに従う。
--no-verifyで hook を迂回しない。- 規約がおかしいと思ったら、philtzjp/.github の
conventions.ymlを直す Issue を起票する。このスキルや hook に規則を書き足さない。
コメント
Markdown 対応