conventions

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

conventions

conventions

コミットメッセージを、Philtz の規約で検査する CLI です。各リポジトリの
.vite-hooks/commit-msg
が呼びます。
このスキルの中身は、philtzjp/organizer-bot の
packages/conventions
と、philtzjp/.github の
conventions.yml
から philtz-organizer-bot が写しています。ここを直接編集しないでください。次に写したときに上書きされます。
用于按照 Philtz 规范检查提交消息的 CLI。由各仓库的
.vite-hooks/commit-msg
调用。
此 skill 的内容由 philtz-organizer-bot 从 philtzjp/organizer-bot 的
packages/conventions
和 philtzjp/.github 的
conventions.yml
复制而来。请勿直接编辑此处,下次复制时会被覆盖。

中身

内容

  • cli.mjs
    : 検査器。依存がなく、Node 22 以上だけで動く
  • conventions.yml
    : 規約。作業中のリポジトリに
    .github/conventions.yml
    があれば、そちらを優先する
  • cli.mjs
    :检查器。无依赖,仅需 Node 22 及以上版本即可运行
  • conventions.yml
    :规范。如果当前操作的仓库中存在
    .github/conventions.yml
    ,则优先使用该文件

hook から呼ぶ

从 hook 调用

sh
#!/bin/sh
cli=.agents/skills/conventions/cli.mjs
if [ ! -f "$cli" ]; then
    echo "書式の検査器がありません。AGENTS.md の手順でスキルを入れてください"
    exit 1
fi
exec node "$cli" commit-msg "$1"
検査器がないときに黙って通すと、検査が効いているように見えて効いていない状態になります。止めて、スキルを入れる手順を出してください。
sh
#!/bin/sh
cli=.agents/skills/conventions/cli.mjs
if [ ! -f "$cli" ]; then
    echo "書式の検査器がありません。AGENTS.md の手順でスキルを入れてください"
    exit 1
fi
exec node "$cli" commit-msg "$1"
如果在没有检查器的情况下默默放行,就会造成检查看似已生效、实际上并未生效的状态。因此应停止提交,并提示安装 skill 的步骤。

検査に落ちたとき

检查未通过时

  • 出たメッセージに従ってコミットメッセージを直す。書き方は github スキルに従う。
  • --no-verify
    で hook を迂回しない。
  • 規約がおかしいと思ったら、philtzjp/.github の
    conventions.yml
    を直す Issue を起票する。このスキルや hook に規則を書き足さない。
  • 根据输出的提示修正提交消息。写法遵循 github skill。
  • 不要使用
    --no-verify
    绕过 hook。
  • 如果认为规范存在问题,请创建一个 Issue,以修正 philtzjp/.github 中的
    conventions.yml
    。不要在此 skill 或 hook 中添加规则。