diff --git a/.github/workflows/pr-check-managed-files-hosted.yml b/.github/workflows/pr-check-managed-files-hosted.yml index 5888e0e..26e5b48 100644 --- a/.github/workflows/pr-check-managed-files-hosted.yml +++ b/.github/workflows/pr-check-managed-files-hosted.yml @@ -68,6 +68,7 @@ on: - .shellcheckrc - REVIEW.md - _typos.toml + - docs/conventions/source-control/commit-convention.yml - docs/standards/README.md - docs/standards/bulk-mutation.md - docs/standards/concise-prose.md diff --git a/docs/conventions/source-control/commit-convention.yml b/docs/conventions/source-control/commit-convention.yml new file mode 100644 index 0000000..c69c92d --- /dev/null +++ b/docs/conventions/source-control/commit-convention.yml @@ -0,0 +1,19 @@ +# SYNC-MANAGED FILE: DO NOT EDIT IN THE CONSUMING REPOSITORY. +# Source of truth: melodic-software/standards, +# components/commit-convention/commit-convention.yml (the `commit-convention` +# component in distribution/sync-manifest.yml). Downstream edits are +# overwritten by the next sync PR; change the component upstream, or move the +# component to `locally-owned` in the manifest to customize. +# +# The org commit-subject convention, read at this well-known path by the +# guardrails commit-msg hook and the source-control plugin: +# https://github.com/melodic-software/claude-code-plugins/blob/main/docs/conventions/commit-convention/README.md +# Flat scalars only, no YAML escape processing: the pattern is single-quoted +# and contains no single quote. +# +# The types are components/pr-convention-policy/policy.json `title.allowedTypes`, +# the scope is optional (`requireScope: false`), and git's own `Merge ...` and +# `Revert "..."` subjects pass. +dialect: posix-ere +subject_pattern: '^((build|chore|ci|docs|feat|fix|perf|refactor|revert|security|style|test)(\(.+\))?!?: .+|Merge .+|Revert ".+)' +pr_title_pattern: Same as `subject_pattern`.