关于 conventions
conventions 是用于按 Philtz 规范检查提交消息的 CLI,由仓库的 `.vite-hooks/commit-msg` 调用。它可优先读取当前仓库的 `.github/conventions.yml`,并作为 skill 分发。
主要功能
- 01按 Philtz 规范检查提交消息
- 02支持仓库级规范配置
- 03供 commit-msg hook 调用
- 04无需依赖,要求 Node 22 以上
适用场景
- 01提交前自动验证提交消息格式
- 02为多个仓库采用各自的规范文件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ philtzjp/ skills --skill conventions安装后在 Claude Code 中输入/conventions确认已加载。
附带文件cli.mjsconventions.yml
详细介绍
来自项目 READMEconventions
コミットメッセージを、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