conventional-git 1.0.0__tar.gz → 1.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.claude-plugin/plugin.json +1 -1
- conventional_git-1.2.0/.github/dependabot.yml +20 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.github/workflows/ci.yml +6 -2
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.github/workflows/publish.yml +3 -3
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.github/workflows/python.yml +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.gitignore +2 -3
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.mcp.json +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.pre-commit-config.yaml +17 -17
- {conventional_git-1.0.0 → conventional_git-1.2.0}/AGENTS.md +4 -26
- {conventional_git-1.0.0 → conventional_git-1.2.0}/Makefile +19 -5
- {conventional_git-1.0.0 → conventional_git-1.2.0}/PKG-INFO +14 -17
- {conventional_git-1.0.0 → conventional_git-1.2.0}/README.md +12 -15
- {conventional_git-1.0.0 → conventional_git-1.2.0}/cspell.config.yaml +1 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/dictionary.txt +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/optional-extras.md +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/three-layers.md +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/vocabulary-as-data.md +3 -1
- conventional_git-1.2.0/docs/conventions/commits-check.md +34 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/conventions/index.md +2 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/pre-commit-framework.md +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/pre-commit-local-hooks.md +2 -2
- conventional_git-1.2.0/docs/log.md +70 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/plugin-bundled-server.md +2 -2
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/python/index.md +0 -4
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/toolchain/index.md +0 -8
- {conventional_git-1.0.0 → conventional_git-1.2.0}/mk/python.mk +16 -5
- {conventional_git-1.0.0 → conventional_git-1.2.0}/package.json +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/pnpm-lock.yaml +120 -120
- {conventional_git-1.0.0 → conventional_git-1.2.0}/pyproject.toml +5 -23
- {conventional_git-1.0.0 → conventional_git-1.2.0}/skills/conventional-branch/SKILL.md +3 -2
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/branch/rules.py +4 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/branch/vocabulary.py +31 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/app.py +2 -2
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/auth.py +2 -2
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/capabilities.py +3 -3
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/check.py +20 -3
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/create.py +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/hook.py +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/mcp.py +1 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/config.py +2 -0
- conventional_git-1.2.0/src/conventional_git/data/branch-exempt-prefixes.csv +3 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/mcp/server.py +10 -4
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_branch_rules.py +26 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_branch_vocabulary.py +20 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_cli_smoke.py +48 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_config.py +3 -1
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_mcp_server.py +1 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_plugin_version.py +3 -4
- {conventional_git-1.0.0 → conventional_git-1.2.0}/uv.lock +66 -103
- conventional_git-1.0.0/docs/log.md +0 -16
- conventional_git-1.0.0/docs/python/docstring-policy.md +0 -16
- conventional_git-1.0.0/docs/python/pylint-plugin.md +0 -21
- conventional_git-1.0.0/docs/toolchain/checkmake.md +0 -13
- conventional_git-1.0.0/docs/toolchain/markdown-tooling.md +0 -14
- conventional_git-1.0.0/docs/toolchain/mise.md +0 -14
- conventional_git-1.0.0/docs/toolchain/pre-commit.md +0 -15
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.claude-plugin/marketplace.json +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.editorconfig +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.markdownlint-cli2.jsonc +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.markdownlint.yaml +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/.pre-commit-hooks.yaml +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/CONTRIBUTING.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/LICENSE +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/checkmake.ini +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/validation-vs-generation.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/architecture/violation-contract.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/conventions/commits-and-branches.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/attribution-trailers.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/branch-name-gap.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/ci-recipe.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/commitizen-adapter.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/git-hooks.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/hook-install-path.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/house-rules.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/skill-vocabulary-copies.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/behavior-vs-cli.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/extra-path.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/install.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/recommended-config.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/when-to-use.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/gitlint/wiring.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/describe-convention.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/self-correction-loop.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/server-install.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/suggest-commit-message.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/mcp/validate-tools.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/python/interpreter-source.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/python/pyproject-defaults.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/release/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/release/pypi-trusted-publishing.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/apply-does-not-commit.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/data-egress.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/index.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/keyring-scope.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/llm-extra-install.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/provider-fallback.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/suggestions/providers-and-credentials.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/toolchain/extras-self-reference.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/toolchain/layering-rule.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/docs/toolchain/rejected-install-backends.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/mise.toml +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/mk/.gitkeep +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/mk/conventional-git.mk +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/pnpm-workspace.yaml +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/skills/conventional-branch/references/branch-types.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/skills/conventional-commit/SKILL.md +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/skills/conventional-commit/references/commit-types.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/adapters/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/adapters/commitizen_config.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/adapters/gitlint_rules.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/branch/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/branch/grammar.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/cli/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/commit/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/commit/compose.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/commit/grammar.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/commit/rules.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/commit/vocabulary.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/csv_columns.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/data/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/data/branch-trunks.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/data/branch-types.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/data/commit-attribution.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/data/commit-types.csv +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/credentials.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/diff.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/heuristic.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/protocol.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/generation/typesafe.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/helpers.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/mcp/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/py.typed +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/src/conventional_git/violations.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/__init__.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_cli_auth.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_cli_capabilities.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_cli_hook.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_commit_compose.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_commit_rules.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_commit_vocabulary.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_credentials.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_diff.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_generation_suggest.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_gitlint_rules.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_helpers.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_heuristic.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_skill_vocabularies.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_typesafe_client_factory.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_typesafe_provider.py +0 -0
- {conventional_git-1.0.0 → conventional_git-1.2.0}/tests/test_violation_code_coverage.py +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
updates:
|
|
3
|
+
- package-ecosystem: github-actions
|
|
4
|
+
directory: /
|
|
5
|
+
schedule:
|
|
6
|
+
interval: weekly
|
|
7
|
+
commit-message:
|
|
8
|
+
prefix: ci
|
|
9
|
+
- package-ecosystem: uv
|
|
10
|
+
directory: /
|
|
11
|
+
schedule:
|
|
12
|
+
interval: weekly
|
|
13
|
+
commit-message:
|
|
14
|
+
prefix: chore
|
|
15
|
+
- package-ecosystem: npm
|
|
16
|
+
directory: /
|
|
17
|
+
schedule:
|
|
18
|
+
interval: weekly
|
|
19
|
+
commit-message:
|
|
20
|
+
prefix: chore
|
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
name: ci
|
|
2
2
|
on:
|
|
3
3
|
push:
|
|
4
|
-
branches: [
|
|
4
|
+
branches: [main]
|
|
5
5
|
pull_request:
|
|
6
6
|
jobs:
|
|
7
7
|
quality:
|
|
8
8
|
runs-on: ubuntu-latest
|
|
9
9
|
steps:
|
|
10
|
-
- uses: actions/checkout@
|
|
10
|
+
- uses: actions/checkout@v7
|
|
11
|
+
with:
|
|
12
|
+
fetch-depth: 0
|
|
13
|
+
ref: ${{ github.event.pull_request.head.sha || github.ref }}
|
|
11
14
|
- uses: jdx/mise-action@v4
|
|
12
15
|
- run: pnpm install --frozen-lockfile
|
|
13
16
|
- run: make makefile-lint
|
|
14
17
|
- run: make md-lint
|
|
15
18
|
- run: make spell
|
|
19
|
+
- run: make commits-check
|
|
16
20
|
- run: pre-commit run --all-files
|
|
@@ -7,10 +7,10 @@ jobs:
|
|
|
7
7
|
build:
|
|
8
8
|
runs-on: ubuntu-latest
|
|
9
9
|
steps:
|
|
10
|
-
- uses: actions/checkout@
|
|
10
|
+
- uses: actions/checkout@v7
|
|
11
11
|
- uses: jdx/mise-action@v4
|
|
12
12
|
- run: make build
|
|
13
|
-
- uses: actions/upload-artifact@
|
|
13
|
+
- uses: actions/upload-artifact@v7
|
|
14
14
|
with:
|
|
15
15
|
name: dist
|
|
16
16
|
path: dist/
|
|
@@ -21,7 +21,7 @@ jobs:
|
|
|
21
21
|
permissions:
|
|
22
22
|
id-token: write
|
|
23
23
|
steps:
|
|
24
|
-
- uses: actions/download-artifact@
|
|
24
|
+
- uses: actions/download-artifact@v8
|
|
25
25
|
with:
|
|
26
26
|
name: dist
|
|
27
27
|
path: dist/
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
mise.local.toml
|
|
5
5
|
.mise.local.toml
|
|
6
6
|
|
|
7
|
-
#
|
|
8
|
-
.
|
|
7
|
+
# Obsidian vault metadata (docs/ is opened directly as a vault)
|
|
8
|
+
.obsidian/
|
|
9
9
|
|
|
10
10
|
# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,jetbrains+all,visualstudiocode,node,python
|
|
11
11
|
# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,jetbrains+all,visualstudiocode,node,python
|
|
@@ -122,7 +122,6 @@ fabric.properties
|
|
|
122
122
|
# Icon must end with two \r
|
|
123
123
|
Icon
|
|
124
124
|
|
|
125
|
-
|
|
126
125
|
# Thumbnails
|
|
127
126
|
._*
|
|
128
127
|
|
|
@@ -27,6 +27,22 @@ repos:
|
|
|
27
27
|
language: system
|
|
28
28
|
pass_filenames: false
|
|
29
29
|
|
|
30
|
+
- id: conventional-commit-msg
|
|
31
|
+
name: conventional-git commit message
|
|
32
|
+
entry: uvx conventional-git@latest check commit --file
|
|
33
|
+
language: system
|
|
34
|
+
stages: [commit-msg]
|
|
35
|
+
types: [text]
|
|
36
|
+
pass_filenames: true
|
|
37
|
+
|
|
38
|
+
- id: conventional-branch-name
|
|
39
|
+
name: conventional-git branch name
|
|
40
|
+
entry: uvx conventional-git@latest check branch
|
|
41
|
+
language: system
|
|
42
|
+
stages: [pre-commit, pre-push]
|
|
43
|
+
always_run: true
|
|
44
|
+
pass_filenames: false
|
|
45
|
+
|
|
30
46
|
- repo: https://github.com/checkmake/checkmake
|
|
31
47
|
rev: v0.3.2
|
|
32
48
|
hooks:
|
|
@@ -56,24 +72,8 @@ repos:
|
|
|
56
72
|
pass_filenames: false
|
|
57
73
|
|
|
58
74
|
- id: pylint
|
|
59
|
-
name: pylint (pylint-
|
|
75
|
+
name: pylint (pylint-gajaguar)
|
|
60
76
|
entry: make pylint
|
|
61
77
|
language: system
|
|
62
78
|
types: [python]
|
|
63
79
|
pass_filenames: false
|
|
64
|
-
|
|
65
|
-
- id: conventional-commit-msg
|
|
66
|
-
name: conventional-git commit message
|
|
67
|
-
entry: uv run conventional-git check commit --file
|
|
68
|
-
language: system
|
|
69
|
-
stages: [commit-msg]
|
|
70
|
-
types: [text]
|
|
71
|
-
pass_filenames: true
|
|
72
|
-
|
|
73
|
-
- id: conventional-branch-name
|
|
74
|
-
name: conventional-git branch name
|
|
75
|
-
entry: uv run conventional-git check branch
|
|
76
|
-
language: system
|
|
77
|
-
stages: [pre-commit, pre-push]
|
|
78
|
-
always_run: true
|
|
79
|
-
pass_filenames: false
|
|
@@ -17,7 +17,9 @@ Commit messages MUST follow
|
|
|
17
17
|
MUST follow [Conventional Branch](https://conventionalbranch.org/)
|
|
18
18
|
(`<type>/<description>`, e.g. `feat/add-enforcement`,
|
|
19
19
|
`fix/normalize-description-grammar`). Both share the same `type` vocabulary
|
|
20
|
-
(`feat`, `fix`, `docs`, `build`, `ci`, `refactor`, `test`, `chore`, ...).
|
|
20
|
+
(`feat`, `fix`, `docs`, `build`, `ci`, `refactor`, `test`, `chore`, ...). A
|
|
21
|
+
pre-commit hook and `make commits-check` enforce both — see
|
|
22
|
+
[`docs/conventions/commits-check.md`](docs/conventions/commits-check.md).
|
|
21
23
|
|
|
22
24
|
## Gate
|
|
23
25
|
|
|
@@ -62,35 +64,11 @@ duplicates it. A new vocabulary entry MUST land in
|
|
|
62
64
|
`data/{commit,branch}-types.csv`; a regex inside the core is a bug, not a
|
|
63
65
|
feature.
|
|
64
66
|
|
|
65
|
-
## Repository metadata
|
|
66
|
-
|
|
67
|
-
The agent MUST populate the GitHub repository metadata before the first
|
|
68
|
-
release, and SHOULD do so in the first commit that follows instantiation of
|
|
69
|
-
this template:
|
|
70
|
-
|
|
71
|
-
- The repository description MUST be set to a single sentence, in English,
|
|
72
|
-
without a trailing period.
|
|
73
|
-
- Repository topics MUST include the primary language and the project kind,
|
|
74
|
-
and SHOULD include the main framework or runtime.
|
|
75
|
-
- The homepage URL MUST be set when the project is deployed or published,
|
|
76
|
-
and MAY be left empty otherwise.
|
|
77
|
-
- `README.md` MUST NOT be the only place where the purpose of the project is
|
|
78
|
-
stated; the description and the README first paragraph MUST agree.
|
|
79
|
-
|
|
80
|
-
The agent SHOULD apply these with `gh`:
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
gh repo edit --description "..." --add-topic <topic> --homepage "..."
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
The agent MUST NOT leave the description empty, and MUST NOT copy the
|
|
87
|
-
description of this template verbatim.
|
|
88
|
-
|
|
89
67
|
## Python
|
|
90
68
|
|
|
91
69
|
- The agent MUST NOT add docstrings to functions, methods, or classes; use a
|
|
92
70
|
comment only where the *why* is not obvious from the code. The
|
|
93
|
-
`pylint-
|
|
71
|
+
`pylint-gajaguar` `gajaguar-no-docstrings` checker enforces this and fails
|
|
94
72
|
`make check`/`make pylint` otherwise.
|
|
95
73
|
- The agent MUST run `make check` and `make test` before committing Python
|
|
96
74
|
changes, and SHOULD run `make fix` first for anything auto-fixable.
|
|
@@ -7,11 +7,18 @@ NPM := pnpm
|
|
|
7
7
|
# Usage: make lint FILES="src/foo.py src/bar.py"
|
|
8
8
|
FILES ?=
|
|
9
9
|
|
|
10
|
+
# The commit range commits-check re-validates in CI (a local hook can be
|
|
11
|
+
# skipped with --no-verify). Override CONVENTIONAL_GIT to run a
|
|
12
|
+
# project-pinned copy instead of an ephemeral uvx fetch — see
|
|
13
|
+
# docs/conventions/commits-check.md.
|
|
14
|
+
BASE ?= origin/main
|
|
15
|
+
CONVENTIONAL_GIT ?= uvx conventional-git@latest
|
|
16
|
+
BRANCH ?= $(or $(GITHUB_HEAD_REF),$(shell git branch --show-current))
|
|
17
|
+
|
|
10
18
|
.DEFAULT_GOAL := help
|
|
11
19
|
|
|
12
|
-
# Extension points. Each
|
|
13
|
-
#
|
|
14
|
-
# language branches never edit the same file.
|
|
20
|
+
# Extension points. Each mk/*.mk file appends its own targets to these
|
|
21
|
+
# variables; -include mk/*.mk below picks up every one.
|
|
15
22
|
LANG_INSTALL_TARGETS :=
|
|
16
23
|
LANG_CHECK_TARGETS :=
|
|
17
24
|
LANG_FIX_TARGETS :=
|
|
@@ -59,9 +66,16 @@ spell: ## Spell-check files with cspell — accepts FILES="..."
|
|
|
59
66
|
pnpm exec cspell --no-progress --no-summary $(if $(FILES),$(FILES),'**'); \
|
|
60
67
|
fi
|
|
61
68
|
|
|
62
|
-
check:
|
|
69
|
+
commits-check: ## Validate the commit range and branch name against Conventional Commits/Branch — see docs/conventions/commits-check.md
|
|
70
|
+
@git log --no-merges --format='%B%x00' $(BASE)..HEAD | while IFS= read -r -d '' message; do \
|
|
71
|
+
message="$${message#$$'\n'}"; [ -z "$$message" ] && continue; \
|
|
72
|
+
echo "$$message" | $(CONVENTIONAL_GIT) check commit || exit 1; \
|
|
73
|
+
done
|
|
74
|
+
@$(CONVENTIONAL_GIT) check branch --name "$(BRANCH)"
|
|
75
|
+
|
|
76
|
+
check: makefile-lint md-lint spell commits-check $(LANG_CHECK_TARGETS) ## Run the full read-only validation gate
|
|
63
77
|
|
|
64
|
-
.PHONY: makefile-lint md-lint spell check
|
|
78
|
+
.PHONY: makefile-lint md-lint spell commits-check check
|
|
65
79
|
|
|
66
80
|
##@ Writable fixes (mutate files in place)
|
|
67
81
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: conventional-git
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.2.0
|
|
4
4
|
Summary: Conventional Commits and Conventional Branch enforcement, validation, and generation
|
|
5
5
|
Project-URL: Repository, https://github.com/gajaguar/conventional-git
|
|
6
6
|
Project-URL: Issues, https://github.com/gajaguar/conventional-git/issues
|
|
@@ -16,7 +16,7 @@ Provides-Extra: llm
|
|
|
16
16
|
Requires-Dist: keyring>=25.7; extra == 'llm'
|
|
17
17
|
Requires-Dist: typesafe-sdk>=0.7; extra == 'llm'
|
|
18
18
|
Provides-Extra: mcp
|
|
19
|
-
Requires-Dist: mcp<2
|
|
19
|
+
Requires-Dist: mcp<3,>=2.2; extra == 'mcp'
|
|
20
20
|
Description-Content-Type: text/markdown
|
|
21
21
|
|
|
22
22
|
# conventional-git
|
|
@@ -43,7 +43,6 @@ generation
|
|
|
43
43
|
- [Architecture](#architecture)
|
|
44
44
|
- [Platform notes](#platform-notes)
|
|
45
45
|
- [Documentation](#documentation)
|
|
46
|
-
- [Open items](#open-items)
|
|
47
46
|
- [Contributing](#contributing)
|
|
48
47
|
- [License](#license)
|
|
49
48
|
|
|
@@ -132,7 +131,9 @@ conventional-git check branch
|
|
|
132
131
|
|
|
133
132
|
The branch command uses the same exit codes. Trunk branches listed in
|
|
134
133
|
`data/branch-trunks.csv` (`main`, `master`, `develop`) are always valid and
|
|
135
|
-
skip the `<type>/` requirement.
|
|
134
|
+
skip the `<type>/` requirement. So are branches that start with a prefix in
|
|
135
|
+
`data/branch-exempt-prefixes.csv` (`dependabot/`, `renovate/`): a bot names
|
|
136
|
+
those branches, and GitHub does not let you rename them.
|
|
136
137
|
|
|
137
138
|
### Generate
|
|
138
139
|
|
|
@@ -275,14 +276,16 @@ Use `conventional-git <command> --help` for the full option descriptions.
|
|
|
275
276
|
|
|
276
277
|
Create `.conventional-git.toml` in the current repository:
|
|
277
278
|
|
|
278
|
-
| Key
|
|
279
|
-
|
|
|
280
|
-
| `[commit] attribution_patterns`
|
|
281
|
-
| `[commit] type_overrides`
|
|
282
|
-
| `[branch] type_overrides`
|
|
283
|
-
| `[branch] trunk_overrides`
|
|
279
|
+
| Key | Default | Purpose |
|
|
280
|
+
| :--------------------------------- | ------------- | -------------------------- |
|
|
281
|
+
| `[commit] attribution_patterns` | built-in list | Extra attribution regexes |
|
|
282
|
+
| `[commit] type_overrides` | `[]` | Extra commit types |
|
|
283
|
+
| `[branch] type_overrides` | `[]` | Extra branch types |
|
|
284
|
+
| `[branch] trunk_overrides` | `[]` | Extra trunk branch names |
|
|
285
|
+
| `[branch] exempt_prefix_overrides` | `[]` | Extra exempt name prefixes |
|
|
284
286
|
|
|
285
|
-
Relative CSV paths in `type_overrides` / `trunk_overrides`
|
|
287
|
+
Relative CSV paths in `type_overrides` / `trunk_overrides` /
|
|
288
|
+
`exempt_prefix_overrides` are resolved
|
|
286
289
|
against the directory containing `.conventional-git.toml`, not the process's
|
|
287
290
|
current directory. Every consumer that loads the file — the CLI, the MCP
|
|
288
291
|
server, and the gitlint adapter — honors it. See
|
|
@@ -342,12 +345,6 @@ script. A repository with `core.hooksPath` pointing elsewhere (for example
|
|
|
342
345
|
bundle: one Markdown note per concept, indexed by
|
|
343
346
|
[`docs/index.md`](docs/index.md).
|
|
344
347
|
|
|
345
|
-
## Open items
|
|
346
|
-
|
|
347
|
-
- `--dry-run` has no effect beyond printing the generated value.
|
|
348
|
-
- The default attribution patterns cannot currently be disabled.
|
|
349
|
-
- The package is not published to PyPI.
|
|
350
|
-
|
|
351
348
|
## Contributing
|
|
352
349
|
|
|
353
350
|
```bash
|
|
@@ -22,7 +22,6 @@ generation
|
|
|
22
22
|
- [Architecture](#architecture)
|
|
23
23
|
- [Platform notes](#platform-notes)
|
|
24
24
|
- [Documentation](#documentation)
|
|
25
|
-
- [Open items](#open-items)
|
|
26
25
|
- [Contributing](#contributing)
|
|
27
26
|
- [License](#license)
|
|
28
27
|
|
|
@@ -111,7 +110,9 @@ conventional-git check branch
|
|
|
111
110
|
|
|
112
111
|
The branch command uses the same exit codes. Trunk branches listed in
|
|
113
112
|
`data/branch-trunks.csv` (`main`, `master`, `develop`) are always valid and
|
|
114
|
-
skip the `<type>/` requirement.
|
|
113
|
+
skip the `<type>/` requirement. So are branches that start with a prefix in
|
|
114
|
+
`data/branch-exempt-prefixes.csv` (`dependabot/`, `renovate/`): a bot names
|
|
115
|
+
those branches, and GitHub does not let you rename them.
|
|
115
116
|
|
|
116
117
|
### Generate
|
|
117
118
|
|
|
@@ -254,14 +255,16 @@ Use `conventional-git <command> --help` for the full option descriptions.
|
|
|
254
255
|
|
|
255
256
|
Create `.conventional-git.toml` in the current repository:
|
|
256
257
|
|
|
257
|
-
| Key
|
|
258
|
-
|
|
|
259
|
-
| `[commit] attribution_patterns`
|
|
260
|
-
| `[commit] type_overrides`
|
|
261
|
-
| `[branch] type_overrides`
|
|
262
|
-
| `[branch] trunk_overrides`
|
|
258
|
+
| Key | Default | Purpose |
|
|
259
|
+
| :--------------------------------- | ------------- | -------------------------- |
|
|
260
|
+
| `[commit] attribution_patterns` | built-in list | Extra attribution regexes |
|
|
261
|
+
| `[commit] type_overrides` | `[]` | Extra commit types |
|
|
262
|
+
| `[branch] type_overrides` | `[]` | Extra branch types |
|
|
263
|
+
| `[branch] trunk_overrides` | `[]` | Extra trunk branch names |
|
|
264
|
+
| `[branch] exempt_prefix_overrides` | `[]` | Extra exempt name prefixes |
|
|
263
265
|
|
|
264
|
-
Relative CSV paths in `type_overrides` / `trunk_overrides`
|
|
266
|
+
Relative CSV paths in `type_overrides` / `trunk_overrides` /
|
|
267
|
+
`exempt_prefix_overrides` are resolved
|
|
265
268
|
against the directory containing `.conventional-git.toml`, not the process's
|
|
266
269
|
current directory. Every consumer that loads the file — the CLI, the MCP
|
|
267
270
|
server, and the gitlint adapter — honors it. See
|
|
@@ -321,12 +324,6 @@ script. A repository with `core.hooksPath` pointing elsewhere (for example
|
|
|
321
324
|
bundle: one Markdown note per concept, indexed by
|
|
322
325
|
[`docs/index.md`](docs/index.md).
|
|
323
326
|
|
|
324
|
-
## Open items
|
|
325
|
-
|
|
326
|
-
- `--dry-run` has no effect beyond printing the generated value.
|
|
327
|
-
- The default attribution patterns cannot currently be disabled.
|
|
328
|
-
- The package is not published to PyPI.
|
|
329
|
-
|
|
330
327
|
## Contributing
|
|
331
328
|
|
|
332
329
|
```bash
|
|
@@ -17,6 +17,7 @@ ignorePaths:
|
|
|
17
17
|
- "**/*.lock"
|
|
18
18
|
- "**/pnpm-lock.yaml"
|
|
19
19
|
- ".gitignore" # vendored toptal.com boilerplate, not authored here
|
|
20
|
+
- "scripts/templates/gitignore/snapshot" # same toptal.com boilerplate, vendored as a fallback
|
|
20
21
|
- "**/.venv/**"
|
|
21
22
|
- "**/.mypy_cache/**"
|
|
22
23
|
- "**/.ruff_cache/**"
|
|
@@ -8,7 +8,7 @@ status: stable
|
|
|
8
8
|
|
|
9
9
|
# Optional extras stay lazily imported
|
|
10
10
|
|
|
11
|
-
`mcp/server.py` —
|
|
11
|
+
`mcp/server.py` — `MCPServer` exposing `validate_commit_message`,
|
|
12
12
|
`validate_branch_name`, `describe_convention`, and `suggest_commit_message`.
|
|
13
13
|
The `validate_*`/`describe_*` tools return the same structured `Violation`
|
|
14
14
|
shape so agents can self-correct; `suggest_commit_message` returns advice,
|
|
@@ -50,7 +50,7 @@ itself reads that config, so the adapter has no SDK to import. See
|
|
|
50
50
|
- `cli/auth.py` — stores/reads the TypeSafe or OpenRouter credential used by
|
|
51
51
|
the `jev` suggestion provider (requires the `llm` extra). See
|
|
52
52
|
[`suggestions/keyring-scope.md`](../suggestions/keyring-scope.md).
|
|
53
|
-
- `mcp/server.py` —
|
|
53
|
+
- `mcp/server.py` — `MCPServer` exposing `validate_commit_message`,
|
|
54
54
|
`validate_branch_name`, `describe_convention`, and `suggest_commit_message`.
|
|
55
55
|
See [`mcp/index.md`](../mcp/index.md). Requires the `mcp` extra; see
|
|
56
56
|
[`optional-extras.md`](optional-extras.md) for how it stays lazy.
|
|
@@ -12,7 +12,9 @@ status: stable
|
|
|
12
12
|
truth for what counts as a valid `type`. New types go in the CSV, never in a
|
|
13
13
|
regex inside the core. `data/branch-trunks.csv` lists trunk branch names
|
|
14
14
|
(`main`, `master`, `develop`) that are accepted as-is, without the
|
|
15
|
-
`<type>/` prefix.
|
|
15
|
+
`<type>/` prefix, and `data/branch-exempt-prefixes.csv` lists name prefixes
|
|
16
|
+
(`dependabot/`, `renovate/`) accepted the same way, because the bot that
|
|
17
|
+
creates the branch picks its name.
|
|
16
18
|
|
|
17
19
|
See [`enforcement/skill-vocabulary-copies.md`](../enforcement/skill-vocabulary-copies.md)
|
|
18
20
|
for how the distributed `skills/*/` copies stay in sync with these files.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: rule
|
|
3
|
+
title: Enforcing commits and branches
|
|
4
|
+
description: A pre-commit hook checks the commit being written and the current branch name; make commits-check re-validates the whole range in CI, through this project's own pinned copy of itself.
|
|
5
|
+
tags: [git]
|
|
6
|
+
status: stable
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Enforcing commits and branches
|
|
10
|
+
|
|
11
|
+
Two layers enforce [Commits and branches](commits-and-branches.md):
|
|
12
|
+
|
|
13
|
+
* **Local**: `.pre-commit-config.yaml`'s `conventional-commit-msg` hook
|
|
14
|
+
checks the message being written (`commit-msg` stage);
|
|
15
|
+
`conventional-branch-name` checks the current branch name (`pre-commit`
|
|
16
|
+
and `pre-push` stages). Both run through `uvx`, unconditionally.
|
|
17
|
+
* **CI**: `make commits-check` re-validates every commit in `$(BASE)..HEAD`
|
|
18
|
+
and the branch name, since a local hook can be bypassed with
|
|
19
|
+
`--no-verify`. It runs as part of `make check`.
|
|
20
|
+
|
|
21
|
+
`mk/python.mk` overrides the base Makefile's `CONVENTIONAL_GIT ?= uvx
|
|
22
|
+
conventional-git@latest` with `$(UV) run conventional-git`, so `make commits-check`
|
|
23
|
+
uses this project's own pinned dev dependency (already synced by `uv sync`)
|
|
24
|
+
instead of an ephemeral `uvx` fetch — faster, and reproducible from the
|
|
25
|
+
lockfile. `.github/workflows/{ci,python}.yml`'s checkout uses `fetch-depth:
|
|
26
|
+
0` and the pull request's head ref, so `$(BASE)` (`origin/main`) and the
|
|
27
|
+
branch name resolve correctly instead of hitting a detached `HEAD`.
|
|
28
|
+
|
|
29
|
+
Dependabot always names its branches `dependabot/<ecosystem>/<dependency>`,
|
|
30
|
+
which is not a Conventional Branch type, and its prefix can't be changed.
|
|
31
|
+
`conventional-git` therefore accepts names that start with `dependabot/` or
|
|
32
|
+
`renovate/` (1.1.0 and later), in the hook and in `make commits-check`
|
|
33
|
+
alike; the commit messages are still validated, and
|
|
34
|
+
`.github/dependabot.yml` sets their `ci`/`chore` prefixes.
|
|
@@ -5,3 +5,5 @@ Commit and branch naming.
|
|
|
5
5
|
* [Commits and branches follow published specs](commits-and-branches.md) -
|
|
6
6
|
Conventional Commits and Conventional Branch, enforced by this project's
|
|
7
7
|
own hooks.
|
|
8
|
+
* [Enforcing commits and branches](commits-check.md) - the pre-commit hook
|
|
9
|
+
and `make commits-check` that enforce them.
|
{conventional_git-1.0.0 → conventional_git-1.2.0}/docs/enforcement/pre-commit-local-hooks.md
RENAMED
|
@@ -21,7 +21,7 @@ repos:
|
|
|
21
21
|
language: python
|
|
22
22
|
language_version: python3.14
|
|
23
23
|
additional_dependencies:
|
|
24
|
-
- conventional-git==1.
|
|
24
|
+
- conventional-git==1.2.0
|
|
25
25
|
stages: [commit-msg]
|
|
26
26
|
pass_filenames: true
|
|
27
27
|
- id: conventional-branch-name
|
|
@@ -30,7 +30,7 @@ repos:
|
|
|
30
30
|
language: python
|
|
31
31
|
language_version: python3.14
|
|
32
32
|
additional_dependencies:
|
|
33
|
-
- conventional-git==1.
|
|
33
|
+
- conventional-git==1.2.0
|
|
34
34
|
stages: [pre-commit, pre-push]
|
|
35
35
|
always_run: true
|
|
36
36
|
pass_filenames: false
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Directory Update Log
|
|
2
|
+
|
|
3
|
+
## 2026-09-29 (3)
|
|
4
|
+
|
|
5
|
+
* **Change**: The `mcp` extra now requires `mcp>=2.2,<3`. `mcp/server.py`
|
|
6
|
+
builds an `MCPServer` (`mcp.server.mcpserver`), the name `FastMCP` took in
|
|
7
|
+
2.x; the tools and their contract are unchanged. Updated
|
|
8
|
+
[`architecture/three-layers.md`](architecture/three-layers.md) and
|
|
9
|
+
[`architecture/optional-extras.md`](architecture/optional-extras.md).
|
|
10
|
+
|
|
11
|
+
## 2026-09-29 (2)
|
|
12
|
+
|
|
13
|
+
* **Change**: `pylint-plugin` (a git dependency whose package was renamed,
|
|
14
|
+
which broke `make install`) is replaced by `pylint-gajaguar` from PyPI, and
|
|
15
|
+
`pyproject.toml` enables it with `enable = ["gajaguar"]`. The `dependabot/*`
|
|
16
|
+
skip in `make commits-check` is gone: the project's own 1.1.0 accepts
|
|
17
|
+
`dependabot/` and `renovate/` branch names. Updated
|
|
18
|
+
[`conventions/commits-check.md`](conventions/commits-check.md).
|
|
19
|
+
|
|
20
|
+
## 2026-09-29
|
|
21
|
+
|
|
22
|
+
* **Addition**: Branch names starting with a prefix listed in
|
|
23
|
+
`data/branch-exempt-prefixes.csv` (`dependabot/`, `renovate/`) now pass
|
|
24
|
+
`check branch`, extendable through `[branch] exempt_prefix_overrides` and
|
|
25
|
+
`--exempt-prefixes-csv`; recorded in
|
|
26
|
+
[`architecture/vocabulary-as-data.md`](architecture/vocabulary-as-data.md).
|
|
27
|
+
|
|
28
|
+
## 2026-09-28 (2)
|
|
29
|
+
|
|
30
|
+
* **Addition**: Added `.github/dependabot.yml` (GitHub Actions, uv, npm,
|
|
31
|
+
weekly). [`conventions/commits-check.md`](conventions/commits-check.md)
|
|
32
|
+
now records that `make commits-check` skips the branch-name check for
|
|
33
|
+
Dependabot's `dependabot/*` branches.
|
|
34
|
+
|
|
35
|
+
## 2026-09-28
|
|
36
|
+
|
|
37
|
+
* **Change**: The plugin's `.mcp.json`, the pre-commit hooks and the
|
|
38
|
+
`Makefile` now resolve `conventional-git` from PyPI at `@latest` instead of
|
|
39
|
+
a pinned version or the editable local install; updated
|
|
40
|
+
`docs/mcp/plugin-bundled-server.md` to match.
|
|
41
|
+
* **Pruning**: Removed `docs/toolchain/{checkmake,markdown-tooling,mise,
|
|
42
|
+
pre-commit}.md` and `docs/python/{docstring-policy,pylint-plugin}.md` —
|
|
43
|
+
each only restated what `make help` or a linter's own message already
|
|
44
|
+
says. Folded `docs/python/commit-range-in-ci.md` into
|
|
45
|
+
`docs/conventions/commits-check.md`, and dropped `AGENTS.md`'s
|
|
46
|
+
"Repository metadata" section (an instantiation-only checklist, stale
|
|
47
|
+
since this project's first release), which had also leaked a scaffold
|
|
48
|
+
tool's own name in its wording.
|
|
49
|
+
|
|
50
|
+
## 2026-09-26
|
|
51
|
+
|
|
52
|
+
* **Addition**: Added `docs/release/`, documenting the new
|
|
53
|
+
`.github/workflows/publish.yml` and its use of PyPI Trusted Publishing
|
|
54
|
+
(OIDC) triggered by a GitHub Release.
|
|
55
|
+
* **Restructuring**: Split `docs/` from eight flat, multi-topic files
|
|
56
|
+
(`architecture.md`, `conventions.md`, `enforcement.md`, `gitlint.md`,
|
|
57
|
+
`llm.md`, `mcp.md`, `python.md`, `toolchain.md`) into an
|
|
58
|
+
[OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)
|
|
59
|
+
bundle of atomic notes. `docs/conventions/` keeps only
|
|
60
|
+
`commits-and-branches.md`, since it documents how this project itself
|
|
61
|
+
enforces the Conventional Commits/Conventional Branch specs via its own
|
|
62
|
+
hooks; the Makefile-scaffold conventions it used to share space with are
|
|
63
|
+
documented once, outside this repository, rather than duplicated here.
|
|
64
|
+
|
|
65
|
+
## 2026-09-27
|
|
66
|
+
|
|
67
|
+
* **Addition**: Added `docs/conventions/commits-check.md`, documenting the
|
|
68
|
+
two-layer enforcement (pre-commit hooks + `make commits-check` in CI) and
|
|
69
|
+
this project's `CONVENTIONAL_GIT` override to run its own pinned
|
|
70
|
+
dependency in CI instead of `uvx`.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
type: tool
|
|
3
3
|
title: The Claude Code plugin's bundled server
|
|
4
|
-
description: The plugin's .mcp.json launches the server via uvx
|
|
4
|
+
description: The plugin's .mcp.json launches the server via uvx tracking the latest PyPI release, needing only uv on PATH.
|
|
5
5
|
tags: [mcp, agents]
|
|
6
6
|
status: stable
|
|
7
7
|
---
|
|
@@ -10,7 +10,7 @@ status: stable
|
|
|
10
10
|
|
|
11
11
|
The Claude Code plugin registers this server through the repo's
|
|
12
12
|
`.mcp.json`, launched with
|
|
13
|
-
`uvx --from 'conventional-git[mcp]
|
|
13
|
+
`uvx --from 'conventional-git[mcp]@latest' conventional-git-mcp` (the exact
|
|
14
14
|
spec is in `.mcp.json`). That command needs only `uv` on `PATH` — no
|
|
15
15
|
separate `conventional-git` install or `mcp` extra.
|
|
16
16
|
`conventional-git capabilities --json` reports `extras.mcp` and
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
Decisions specific to this project's Python implementation.
|
|
4
4
|
|
|
5
|
-
* [No docstrings](docstring-policy.md) - comments only where the *why*
|
|
6
|
-
isn't obvious.
|
|
7
|
-
* [The pylint-plugin dependency](pylint-plugin.md) - personal review
|
|
8
|
-
preferences beyond ruff's rule set.
|
|
9
5
|
* [Interpreter source](interpreter-source.md) - `mise.toml` as the single
|
|
10
6
|
source for the pinned Python version.
|
|
11
7
|
* [Defaults relied on](pyproject-defaults.md) - settings intentionally left
|
|
@@ -8,13 +8,5 @@ and why.
|
|
|
8
8
|
* [Rejected install backends](rejected-install-backends.md) - the mise
|
|
9
9
|
`npm:`/`pipx:` backends and pre-commit-managed environments this rules
|
|
10
10
|
out.
|
|
11
|
-
* [mise pins the high-level toolchain](mise.md) - Node, pnpm, pre-commit,
|
|
12
|
-
and the Python runtime.
|
|
13
|
-
* [markdownlint-cli2 and cspell](markdown-tooling.md) - Markdown lint and
|
|
14
|
-
spell check.
|
|
15
|
-
* [checkmake lints the Makefile](checkmake.md) - a Go binary with no
|
|
16
|
-
ecosystem in this repo.
|
|
17
|
-
* [pre-commit runs the shared checks](pre-commit.md) - the git hook
|
|
18
|
-
framework running the shared checks.
|
|
19
11
|
* [The dev group self-references its own extras](extras-self-reference.md) -
|
|
20
12
|
`conventional-git[gitlint,llm,mcp]`, not a second pin.
|