conventional-git 1.3.0__tar.gz → 2.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.3.0 → conventional_git-2.2.0}/.claude-plugin/plugin.json +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.github/workflows/ci.yml +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.github/workflows/publish.yml +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.github/workflows/python.yml +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.gitignore +4 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.pre-commit-config.yaml +10 -3
- {conventional_git-1.3.0 → conventional_git-2.2.0}/AGENTS.md +16 -4
- {conventional_git-1.3.0 → conventional_git-2.2.0}/Makefile +22 -3
- {conventional_git-1.3.0 → conventional_git-2.2.0}/PKG-INFO +28 -18
- {conventional_git-1.3.0 → conventional_git-2.2.0}/README.md +27 -17
- {conventional_git-1.3.0 → conventional_git-2.2.0}/dictionary.txt +3 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/agent-skills-format.md +1 -2
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-install-scopes.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-marketplace-install.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-plugin-updates.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-shell-install.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-skill-invocation.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/install-channels.md +1 -2
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/npx-skills-install.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/npx-skills-manage.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/opencode-mcp-config.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/opencode-mcp-server.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/opencode-skill-discovery.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/opencode-skill-permissions.md +0 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/plugin-identity.md +6 -5
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/conventions/claude-md-check.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/conventions/help-check.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/conventions/index.md +4 -0
- conventional_git-2.2.0/docs/conventions/tag-vocabulary.md +28 -0
- conventional_git-2.2.0/docs/conventions/versioning.md +47 -0
- conventional_git-2.2.0/docs/enforcement/attribution-trailers.md +31 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/git-hooks.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/hook-install-path.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/pre-commit-local-hooks.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/install.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/log.md +65 -18
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/index.md +4 -0
- conventional_git-2.2.0/docs/mcp/no-auth-tools.md +23 -0
- conventional_git-2.2.0/docs/mcp/out-of-band-auth.md +39 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/plugin-bundled-server.md +4 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/suggest-commit-message.md +29 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/python/interpreter-source.md +1 -1
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/toolchain/index.md +2 -0
- conventional_git-2.2.0/docs/toolchain/layering-rule.md +28 -0
- conventional_git-2.2.0/docs/toolchain/retag-notes.md +29 -0
- conventional_git-2.2.0/hooks/hooks.json +31 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/mk/python.mk +13 -6
- conventional_git-2.2.0/okf-base.yaml +42 -0
- conventional_git-2.2.0/package.json +8 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/pnpm-lock.yaml +284 -278
- conventional_git-2.2.0/pnpm-workspace.yaml +3 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/pyproject.toml +21 -5
- conventional_git-2.2.0/skills/conventional-auth/SKILL.md +67 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/skills/conventional-branch/SKILL.md +1 -3
- {conventional_git-1.3.0 → conventional_git-2.2.0}/skills/conventional-commit/SKILL.md +8 -9
- conventional_git-2.2.0/skills/conventional-suggest/SKILL.md +86 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/adapters/gitlint_rules.py +6 -3
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/check.py +21 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/create.py +13 -14
- conventional_git-2.2.0/src/conventional_git/cli/pr_command.py +94 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/commit/rules.py +26 -8
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/commit/vocabulary.py +2 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/config.py +2 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/helpers.py +3 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/mcp/server.py +1 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_cli_smoke.py +123 -4
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_commit_rules.py +37 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_commit_vocabulary.py +15 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_config.py +20 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_gitlint_rules.py +19 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_helpers.py +16 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_plugin_version.py +19 -0
- conventional_git-2.2.0/tools/docs-retag.py +141 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/uv.lock +211 -215
- conventional_git-1.3.0/docs/enforcement/attribution-trailers.md +0 -17
- conventional_git-1.3.0/docs/toolchain/layering-rule.md +0 -35
- conventional_git-1.3.0/package.json +0 -8
- conventional_git-1.3.0/pnpm-workspace.yaml +0 -2
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.claude-plugin/marketplace.json +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.editorconfig +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.github/dependabot.yml +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.markdownlint-cli2.jsonc +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.markdownlint.yaml +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.mcp.json +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/.pre-commit-hooks.yaml +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/CONTRIBUTING.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/LICENSE +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/checkmake.ini +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/cspell.config.yaml +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/optional-extras.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/three-layers.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/validation-vs-generation.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/violation-contract.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/architecture/vocabulary-as-data.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/conventions/commits-and-branches.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/conventions/commits-check.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/branch-name-gap.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/ci-recipe.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/commitizen-adapter.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/house-rules.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/pre-commit-framework.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/enforcement/skill-vocabulary-copies.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/behavior-vs-cli.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/extra-path.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/recommended-config.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/when-to-use.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/gitlint/wiring.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/describe-convention.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/self-correction-loop.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/server-install.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/mcp/validate-tools.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/python/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/python/pyproject-defaults.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/release/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/release/pypi-trusted-publishing.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/apply-does-not-commit.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/data-egress.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/index.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/keyring-scope.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/llm-extra-install.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/provider-fallback.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/suggestions/providers-and-credentials.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/toolchain/extras-self-reference.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/toolchain/rejected-install-backends.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/docs/toolchain/sh-uid-unused.md +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/mise.toml +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/mk/.gitkeep +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/mk/conventional-git.mk +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/skills/conventional-branch/references/branch-types.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/skills/conventional-commit/references/commit-types.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/adapters/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/adapters/commitizen_config.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/branch/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/branch/grammar.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/branch/rules.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/branch/vocabulary.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/app.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/auth.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/capabilities.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/hook.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/cli/mcp.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/commit/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/commit/compose.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/commit/grammar.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/csv_columns.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/branch-exempt-prefixes.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/branch-trunks.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/branch-types.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/commit-attribution.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/data/commit-types.csv +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/credentials.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/diff.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/heuristic.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/protocol.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/generation/typesafe.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/mcp/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/py.typed +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/src/conventional_git/violations.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/__init__.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_branch_rules.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_branch_vocabulary.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_cli_auth.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_cli_capabilities.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_cli_hook.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_commit_compose.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_credentials.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_diff.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_generation_suggest.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_heuristic.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_mcp_server.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_sh_uid_unused.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_skill_vocabularies.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_typesafe_client_factory.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_typesafe_provider.py +0 -0
- {conventional_git-1.3.0 → conventional_git-2.2.0}/tests/test_violation_code_coverage.py +0 -0
|
@@ -7,6 +7,9 @@ mise.local.toml
|
|
|
7
7
|
# Obsidian vault metadata (docs/ is opened directly as a vault)
|
|
8
8
|
.obsidian/
|
|
9
9
|
|
|
10
|
+
# Answers and batches of `make docs-retag`
|
|
11
|
+
.cache/
|
|
12
|
+
|
|
10
13
|
# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,jetbrains+all,visualstudiocode,node,python
|
|
11
14
|
# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,jetbrains+all,visualstudiocode,node,python
|
|
12
15
|
|
|
@@ -474,3 +477,4 @@ pyrightconfig.json
|
|
|
474
477
|
.ionide
|
|
475
478
|
|
|
476
479
|
# End of https://www.toptal.com/developers/gitignore/api/linux,macos,jetbrains+all,visualstudiocode,node,python
|
|
480
|
+
.ferrolint-cache/
|
|
@@ -27,6 +27,13 @@ repos:
|
|
|
27
27
|
language: system
|
|
28
28
|
pass_filenames: false
|
|
29
29
|
|
|
30
|
+
- id: docs-lint
|
|
31
|
+
name: okflint
|
|
32
|
+
entry: make docs-lint
|
|
33
|
+
language: system
|
|
34
|
+
files: ^(docs/.*\.md|okf-base\.yaml)$
|
|
35
|
+
pass_filenames: false
|
|
36
|
+
|
|
30
37
|
- id: conventional-commit-msg
|
|
31
38
|
name: conventional-git commit message
|
|
32
39
|
entry: uvx conventional-git@latest check commit --file
|
|
@@ -71,9 +78,9 @@ repos:
|
|
|
71
78
|
types: [python]
|
|
72
79
|
pass_filenames: false
|
|
73
80
|
|
|
74
|
-
- id:
|
|
75
|
-
name:
|
|
76
|
-
entry: make
|
|
81
|
+
- id: ferrolint
|
|
82
|
+
name: ferrolint (pylint-gajaguar)
|
|
83
|
+
entry: make ferrolint
|
|
77
84
|
language: system
|
|
78
85
|
types: [python]
|
|
79
86
|
pass_filenames: false
|
|
@@ -47,13 +47,20 @@ Once a pull request is open, the agent MUST:
|
|
|
47
47
|
3. Delete the branch on the remote and locally.
|
|
48
48
|
4. Switch back to the base branch, pull it and run `git fetch --prune`.
|
|
49
49
|
|
|
50
|
+
## Versioning and releases
|
|
51
|
+
|
|
52
|
+
- Decide every version bump, tag and release as
|
|
53
|
+
[`docs/conventions/versioning.md`](docs/conventions/versioning.md) defines;
|
|
54
|
+
it is the only place those rules live.
|
|
55
|
+
|
|
50
56
|
## Documentation
|
|
51
57
|
|
|
52
58
|
- Follow the organization's shared documentation-writing guide, kept in one
|
|
53
59
|
place rather than copied into this repository so it cannot drift from other
|
|
54
60
|
projects that follow the same guide.
|
|
55
61
|
- Add a new `docs/` note to its directory's `index.md` and, by file name, to
|
|
56
|
-
[`docs/log.md`](docs/log.md)
|
|
62
|
+
[`docs/log.md`](docs/log.md); `make docs-lint` fails on a missing field or a
|
|
63
|
+
broken link.
|
|
57
64
|
- Cover exactly one concept per note.
|
|
58
65
|
- Write a note only when it explains something a reader cannot already get
|
|
59
66
|
from `make help`, a linter's own message, or the configuration it comes
|
|
@@ -94,12 +101,17 @@ feature.
|
|
|
94
101
|
- Write no docstrings on functions, methods or classes; add a comment only
|
|
95
102
|
where the *why* is not obvious from the code. `pylint-gajaguar`'s
|
|
96
103
|
`gajaguar-no-docstrings` fails `make check` on any docstring.
|
|
97
|
-
- Enable the plugin
|
|
98
|
-
`[tool.pylint."messages control"]`,
|
|
99
|
-
|
|
104
|
+
- Enable the plugin's rules by symbol in `pyproject.toml`'s
|
|
105
|
+
`[tool.pylint."messages control"]`, after `disable = ["all"]`: ferrolint
|
|
106
|
+
does not read the `gajaguar` checker name, and without `disable` its own
|
|
107
|
+
ported pylint rules run too. Add a rule that a `pylint-gajaguar` upgrade
|
|
108
|
+
ships to the list; ruff covers everything else.
|
|
100
109
|
- Keep `pyproject.toml` to settings that differ from the tool's default, and
|
|
101
110
|
keep a `lint.per-file-ignores` entry only while it matches a current
|
|
102
111
|
violation; see
|
|
103
112
|
[`docs/python/pyproject-defaults.md`](docs/python/pyproject-defaults.md).
|
|
104
113
|
- Keep the spec core free of `git` imports and `SystemExit`. Returning a
|
|
105
114
|
`Report` is the contract; only front-ends turn violations into exit codes.
|
|
115
|
+
- Tag a minor or major bump with `make release-tag` after its pull request
|
|
116
|
+
merges, as [`docs/conventions/versioning.md`](docs/conventions/versioning.md)
|
|
117
|
+
describes; the target tags the base branch as `v<project.version>`.
|
|
@@ -13,6 +13,9 @@ FILES ?=
|
|
|
13
13
|
# docs/conventions/commits-check.md.
|
|
14
14
|
BASE ?= origin/main
|
|
15
15
|
CONVENTIONAL_GIT ?= uvx conventional-git@latest
|
|
16
|
+
OKFLINT ?= uvx okflint@latest
|
|
17
|
+
TYPESAFE ?= uvx --from typesafe-unofficial-cli@latest typesafe
|
|
18
|
+
DOCS_RETAG := uv run --script tools/docs-retag.py
|
|
16
19
|
BRANCH ?= $(or $(GITHUB_HEAD_REF),$(shell git branch --show-current))
|
|
17
20
|
|
|
18
21
|
.DEFAULT_GOAL := help
|
|
@@ -68,7 +71,7 @@ spell: ## Spell-check files with cspell — accepts FILES="..."
|
|
|
68
71
|
|
|
69
72
|
commits-check: ## Validate the commit range and branch name against Conventional Commits/Branch — see docs/conventions/commits-check.md
|
|
70
73
|
@git log --no-merges --format='%B%x00' $(BASE)..HEAD | while IFS= read -r -d '' message; do \
|
|
71
|
-
message="$${message#$$'\n'}";
|
|
74
|
+
message="$${message#$$'\n'}"; \
|
|
72
75
|
echo "$$message" | $(CONVENTIONAL_GIT) check commit || exit 1; \
|
|
73
76
|
done
|
|
74
77
|
@$(CONVENTIONAL_GIT) check branch --name "$(BRANCH)"
|
|
@@ -81,9 +84,12 @@ claude-md-check: ## Fail if a CLAUDE.md exists, since AGENTS.md is the only agen
|
|
|
81
84
|
@found=$$(git ls-files --cached --others --exclude-standard | grep -E '(^|/)CLAUDE\.md$$' || true); \
|
|
82
85
|
test -z "$$found" || { echo "CLAUDE.md found; fold it into AGENTS.md and delete it:" >&2; echo "$$found" >&2; exit 1; }
|
|
83
86
|
|
|
84
|
-
|
|
87
|
+
docs-lint: ## Validate docs/ as an OKF bundle with okflint — see docs/toolchain/okflint.md
|
|
88
|
+
@$(OKFLINT) validate
|
|
85
89
|
|
|
86
|
-
|
|
90
|
+
check: makefile-lint md-lint spell docs-lint commits-check help-check claude-md-check $(LANG_CHECK_TARGETS) ## Run the full read-only validation gate
|
|
91
|
+
|
|
92
|
+
.PHONY: makefile-lint md-lint spell docs-lint commits-check help-check claude-md-check check
|
|
87
93
|
|
|
88
94
|
##@ Writable fixes (mutate files in place)
|
|
89
95
|
|
|
@@ -114,3 +120,16 @@ fix-unsafe: _md-fix-scoped $(LANG_FIX_UNSAFE_TARGETS) ## Apply all auto-fixes, i
|
|
|
114
120
|
test: $(LANG_TEST_TARGETS) ## Run the test suite
|
|
115
121
|
|
|
116
122
|
.PHONY: test
|
|
123
|
+
|
|
124
|
+
##@ Docs tagging (optional, billed — not part of check)
|
|
125
|
+
|
|
126
|
+
docs-retag: ## Ask TypeSafe which tags each docs/ note carries, then show a dry run — one billed request per note
|
|
127
|
+
@$(DOCS_RETAG) build
|
|
128
|
+
@$(TYPESAFE) -o jsonl ask --states-file .cache/docs-retag/states.jsonl --questions-file .cache/docs-retag/questions.json --concurrency 4 > .cache/docs-retag/answers.jsonl
|
|
129
|
+
@$(DOCS_RETAG) apply
|
|
130
|
+
|
|
131
|
+
docs-retag-apply: ## Write the tags from the last docs-retag run into the notes, then validate docs/
|
|
132
|
+
@$(DOCS_RETAG) apply --write
|
|
133
|
+
@$(MAKE) docs-lint
|
|
134
|
+
|
|
135
|
+
.PHONY: docs-retag docs-retag-apply
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: conventional-git
|
|
3
|
-
Version:
|
|
3
|
+
Version: 2.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
|
|
@@ -129,6 +129,11 @@ conventional-git check branch -n feat/add-login
|
|
|
129
129
|
conventional-git check branch
|
|
130
130
|
```
|
|
131
131
|
|
|
132
|
+
`conventional-git check command` applies the same attribution rule to pull
|
|
133
|
+
request descriptions (`gh pr create|edit`, `bitbucket pr create|update`): it
|
|
134
|
+
reads the command from stdin and exits `2` on a violation. The plugin's hook
|
|
135
|
+
runs it before those commands.
|
|
136
|
+
|
|
132
137
|
The branch command uses the same exit codes. Trunk branches listed in
|
|
133
138
|
`data/branch-trunks.csv` (`main`, `master`, `develop`) are always valid and
|
|
134
139
|
skip the `<type>/` requirement. So are branches that start with a prefix in
|
|
@@ -146,9 +151,6 @@ conventional-git create branch --type feature --description "add login"
|
|
|
146
151
|
# feature/add-login
|
|
147
152
|
```
|
|
148
153
|
|
|
149
|
-
Use `--dry-run` when you need the generated value without taking further
|
|
150
|
-
action. The current implementation prints the value in either mode.
|
|
151
|
-
|
|
152
154
|
### Enforce
|
|
153
155
|
|
|
154
156
|
Install `commit-msg`, `pre-commit`, and `pre-push` hooks in a repository:
|
|
@@ -170,8 +172,9 @@ credential, `create suggest` always falls back to the built-in heuristic
|
|
|
170
172
|
provider and prints a notice; it never fails the command:
|
|
171
173
|
|
|
172
174
|
```bash
|
|
173
|
-
|
|
175
|
+
conventional-git create suggest
|
|
174
176
|
conventional-git create suggest --diff-file changes.diff --apply
|
|
177
|
+
git diff main... | conventional-git create suggest --diff-file -
|
|
175
178
|
```
|
|
176
179
|
|
|
177
180
|
With the `llm` extra installed and a credential available, `create suggest`
|
|
@@ -218,7 +221,10 @@ uvx --from 'conventional-git[mcp]' conventional-git-mcp
|
|
|
218
221
|
```
|
|
219
222
|
|
|
220
223
|
The server exposes `validate_commit_message`, `validate_branch_name`,
|
|
221
|
-
`describe_convention`, and `suggest_commit_message`.
|
|
224
|
+
`describe_convention`, and `suggest_commit_message`. The server has no auth
|
|
225
|
+
tools: for `suggest_commit_message` to use `jev`, run
|
|
226
|
+
`conventional-git auth login` first and launch it with the `llm` extra (see
|
|
227
|
+
[`docs/mcp/out-of-band-auth.md`](docs/mcp/out-of-band-auth.md)). See
|
|
222
228
|
[`docs/mcp/index.md`](docs/mcp/index.md).
|
|
223
229
|
|
|
224
230
|
## Agents
|
|
@@ -229,7 +235,8 @@ directory. See [`docs/agents/index.md`](docs/agents/index.md) for the full
|
|
|
229
235
|
install guide; one command per channel.
|
|
230
236
|
|
|
231
237
|
**Claude Code**: add the marketplace, then install the plugin. It bundles
|
|
232
|
-
`conventional-commit`, `conventional-branch`,
|
|
238
|
+
`conventional-commit`, `conventional-branch`, `conventional-suggest`,
|
|
239
|
+
`conventional-auth`, and the MCP server:
|
|
233
240
|
|
|
234
241
|
```text
|
|
235
242
|
/plugin marketplace add gajaguar/conventional-git
|
|
@@ -267,8 +274,9 @@ return `1`.
|
|
|
267
274
|
| :------------- | ---------------------------------------------------------------------------------------- | ------------: |
|
|
268
275
|
| check commit | `-m, --message`; `-f, --file`; `--types-csv` | 0 or 1 |
|
|
269
276
|
| check branch | `-n, --name`; `--types-csv` | 0 or 1 |
|
|
270
|
-
|
|
|
271
|
-
| create
|
|
277
|
+
| check command | No options; reads a shell command or hook JSON from stdin | 0 or 2 |
|
|
278
|
+
| create commit | `--type`; `--description`; `--scope`; `--body`; `--breaking`; `--types-csv` | 0 or 1 |
|
|
279
|
+
| create branch | `--type`; `--description`; `--types-csv` | 0 or 1 |
|
|
272
280
|
| create suggest | `--diff-file`; `--provider`; `--apply` | 0 or 1 |
|
|
273
281
|
| hook install | `--target`; `--force` | 0 or 1 |
|
|
274
282
|
| hook uninstall | `--target` | 0 |
|
|
@@ -284,13 +292,14 @@ Use `conventional-git <command> --help` for the full option descriptions.
|
|
|
284
292
|
|
|
285
293
|
Create `.conventional-git.toml` in the current repository:
|
|
286
294
|
|
|
287
|
-
| Key
|
|
288
|
-
|
|
|
289
|
-
| `[commit] attribution_patterns`
|
|
290
|
-
| `[commit]
|
|
291
|
-
| `[
|
|
292
|
-
| `[branch]
|
|
293
|
-
| `[branch]
|
|
295
|
+
| Key | Default | Purpose |
|
|
296
|
+
| :---------------------------------------------- | ------------- | ---------------------------------- |
|
|
297
|
+
| `[commit] attribution_patterns` | built-in list | Extra attribution regexes |
|
|
298
|
+
| `[commit] disable_default_attribution_patterns` | `false` | Skip the built-in attribution list |
|
|
299
|
+
| `[commit] type_overrides` | `[]` | Extra commit types |
|
|
300
|
+
| `[branch] type_overrides` | `[]` | Extra branch types |
|
|
301
|
+
| `[branch] trunk_overrides` | `[]` | Extra trunk branch names |
|
|
302
|
+
| `[branch] exempt_prefix_overrides` | `[]` | Extra exempt name prefixes |
|
|
294
303
|
|
|
295
304
|
Relative CSV paths in `type_overrides` / `trunk_overrides` /
|
|
296
305
|
`exempt_prefix_overrides` are resolved
|
|
@@ -298,7 +307,8 @@ against the directory containing `.conventional-git.toml`, not the process's
|
|
|
298
307
|
current directory. Every consumer that loads the file — the CLI, the MCP
|
|
299
308
|
server, and the gitlint adapter — honors it. See
|
|
300
309
|
[`docs/enforcement/attribution-trailers.md`](docs/enforcement/attribution-trailers.md)
|
|
301
|
-
for what `attribution_patterns` extends
|
|
310
|
+
for what `attribution_patterns` extends and how
|
|
311
|
+
`disable_default_attribution_patterns` turns the built-in list off.
|
|
302
312
|
|
|
303
313
|
The `--types-csv` option extends the default vocabulary; it does not replace
|
|
304
314
|
it. Vocabulary files live in `data/{commit,branch}-types.csv`.
|
|
@@ -335,7 +345,7 @@ and render its output. See [`docs/architecture/index.md`](docs/architecture/inde
|
|
|
335
345
|
│ ├── adapters/{gitlint_rules,commitizen_config}.py
|
|
336
346
|
│ ├── cli/{app,auth,check,create,hook,mcp}.py
|
|
337
347
|
│ └── mcp/server.py
|
|
338
|
-
├── skills/conventional-{commit,branch}/SKILL.md
|
|
348
|
+
├── skills/conventional-{commit,branch,suggest,auth}/SKILL.md
|
|
339
349
|
└── tests/
|
|
340
350
|
```
|
|
341
351
|
|
|
@@ -108,6 +108,11 @@ conventional-git check branch -n feat/add-login
|
|
|
108
108
|
conventional-git check branch
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
+
`conventional-git check command` applies the same attribution rule to pull
|
|
112
|
+
request descriptions (`gh pr create|edit`, `bitbucket pr create|update`): it
|
|
113
|
+
reads the command from stdin and exits `2` on a violation. The plugin's hook
|
|
114
|
+
runs it before those commands.
|
|
115
|
+
|
|
111
116
|
The branch command uses the same exit codes. Trunk branches listed in
|
|
112
117
|
`data/branch-trunks.csv` (`main`, `master`, `develop`) are always valid and
|
|
113
118
|
skip the `<type>/` requirement. So are branches that start with a prefix in
|
|
@@ -125,9 +130,6 @@ conventional-git create branch --type feature --description "add login"
|
|
|
125
130
|
# feature/add-login
|
|
126
131
|
```
|
|
127
132
|
|
|
128
|
-
Use `--dry-run` when you need the generated value without taking further
|
|
129
|
-
action. The current implementation prints the value in either mode.
|
|
130
|
-
|
|
131
133
|
### Enforce
|
|
132
134
|
|
|
133
135
|
Install `commit-msg`, `pre-commit`, and `pre-push` hooks in a repository:
|
|
@@ -149,8 +151,9 @@ credential, `create suggest` always falls back to the built-in heuristic
|
|
|
149
151
|
provider and prints a notice; it never fails the command:
|
|
150
152
|
|
|
151
153
|
```bash
|
|
152
|
-
|
|
154
|
+
conventional-git create suggest
|
|
153
155
|
conventional-git create suggest --diff-file changes.diff --apply
|
|
156
|
+
git diff main... | conventional-git create suggest --diff-file -
|
|
154
157
|
```
|
|
155
158
|
|
|
156
159
|
With the `llm` extra installed and a credential available, `create suggest`
|
|
@@ -197,7 +200,10 @@ uvx --from 'conventional-git[mcp]' conventional-git-mcp
|
|
|
197
200
|
```
|
|
198
201
|
|
|
199
202
|
The server exposes `validate_commit_message`, `validate_branch_name`,
|
|
200
|
-
`describe_convention`, and `suggest_commit_message`.
|
|
203
|
+
`describe_convention`, and `suggest_commit_message`. The server has no auth
|
|
204
|
+
tools: for `suggest_commit_message` to use `jev`, run
|
|
205
|
+
`conventional-git auth login` first and launch it with the `llm` extra (see
|
|
206
|
+
[`docs/mcp/out-of-band-auth.md`](docs/mcp/out-of-band-auth.md)). See
|
|
201
207
|
[`docs/mcp/index.md`](docs/mcp/index.md).
|
|
202
208
|
|
|
203
209
|
## Agents
|
|
@@ -208,7 +214,8 @@ directory. See [`docs/agents/index.md`](docs/agents/index.md) for the full
|
|
|
208
214
|
install guide; one command per channel.
|
|
209
215
|
|
|
210
216
|
**Claude Code**: add the marketplace, then install the plugin. It bundles
|
|
211
|
-
`conventional-commit`, `conventional-branch`,
|
|
217
|
+
`conventional-commit`, `conventional-branch`, `conventional-suggest`,
|
|
218
|
+
`conventional-auth`, and the MCP server:
|
|
212
219
|
|
|
213
220
|
```text
|
|
214
221
|
/plugin marketplace add gajaguar/conventional-git
|
|
@@ -246,8 +253,9 @@ return `1`.
|
|
|
246
253
|
| :------------- | ---------------------------------------------------------------------------------------- | ------------: |
|
|
247
254
|
| check commit | `-m, --message`; `-f, --file`; `--types-csv` | 0 or 1 |
|
|
248
255
|
| check branch | `-n, --name`; `--types-csv` | 0 or 1 |
|
|
249
|
-
|
|
|
250
|
-
| create
|
|
256
|
+
| check command | No options; reads a shell command or hook JSON from stdin | 0 or 2 |
|
|
257
|
+
| create commit | `--type`; `--description`; `--scope`; `--body`; `--breaking`; `--types-csv` | 0 or 1 |
|
|
258
|
+
| create branch | `--type`; `--description`; `--types-csv` | 0 or 1 |
|
|
251
259
|
| create suggest | `--diff-file`; `--provider`; `--apply` | 0 or 1 |
|
|
252
260
|
| hook install | `--target`; `--force` | 0 or 1 |
|
|
253
261
|
| hook uninstall | `--target` | 0 |
|
|
@@ -263,13 +271,14 @@ Use `conventional-git <command> --help` for the full option descriptions.
|
|
|
263
271
|
|
|
264
272
|
Create `.conventional-git.toml` in the current repository:
|
|
265
273
|
|
|
266
|
-
| Key
|
|
267
|
-
|
|
|
268
|
-
| `[commit] attribution_patterns`
|
|
269
|
-
| `[commit]
|
|
270
|
-
| `[
|
|
271
|
-
| `[branch]
|
|
272
|
-
| `[branch]
|
|
274
|
+
| Key | Default | Purpose |
|
|
275
|
+
| :---------------------------------------------- | ------------- | ---------------------------------- |
|
|
276
|
+
| `[commit] attribution_patterns` | built-in list | Extra attribution regexes |
|
|
277
|
+
| `[commit] disable_default_attribution_patterns` | `false` | Skip the built-in attribution list |
|
|
278
|
+
| `[commit] type_overrides` | `[]` | Extra commit types |
|
|
279
|
+
| `[branch] type_overrides` | `[]` | Extra branch types |
|
|
280
|
+
| `[branch] trunk_overrides` | `[]` | Extra trunk branch names |
|
|
281
|
+
| `[branch] exempt_prefix_overrides` | `[]` | Extra exempt name prefixes |
|
|
273
282
|
|
|
274
283
|
Relative CSV paths in `type_overrides` / `trunk_overrides` /
|
|
275
284
|
`exempt_prefix_overrides` are resolved
|
|
@@ -277,7 +286,8 @@ against the directory containing `.conventional-git.toml`, not the process's
|
|
|
277
286
|
current directory. Every consumer that loads the file — the CLI, the MCP
|
|
278
287
|
server, and the gitlint adapter — honors it. See
|
|
279
288
|
[`docs/enforcement/attribution-trailers.md`](docs/enforcement/attribution-trailers.md)
|
|
280
|
-
for what `attribution_patterns` extends
|
|
289
|
+
for what `attribution_patterns` extends and how
|
|
290
|
+
`disable_default_attribution_patterns` turns the built-in list off.
|
|
281
291
|
|
|
282
292
|
The `--types-csv` option extends the default vocabulary; it does not replace
|
|
283
293
|
it. Vocabulary files live in `data/{commit,branch}-types.csv`.
|
|
@@ -314,7 +324,7 @@ and render its output. See [`docs/architecture/index.md`](docs/architecture/inde
|
|
|
314
324
|
│ ├── adapters/{gitlint_rules,commitizen_config}.py
|
|
315
325
|
│ ├── cli/{app,auth,check,create,hook,mcp}.py
|
|
316
326
|
│ └── mcp/server.py
|
|
317
|
-
├── skills/conventional-{commit,branch}/SKILL.md
|
|
327
|
+
├── skills/conventional-{commit,branch,suggest,auth}/SKILL.md
|
|
318
328
|
└── tests/
|
|
319
329
|
```
|
|
320
330
|
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
type: reference
|
|
3
3
|
title: Agent Skills format
|
|
4
4
|
description: SKILL.md frontmatter fields and their constraints, progressive disclosure, and the optional references/ subdirectory.
|
|
5
|
-
tags: [agents, skills]
|
|
5
|
+
tags: [agents, skills, documentation]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: agentskills-spec
|
|
@@ -4,7 +4,6 @@ title: Claude Code install scopes
|
|
|
4
4
|
description: user, project, and local scopes — which settings file each writes to, the precedence order, and when each is the right choice.
|
|
5
5
|
tags: [agents, claude-code]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
{conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-marketplace-install.md
RENAMED
|
@@ -4,7 +4,6 @@ title: Installing through the Claude Code marketplace
|
|
|
4
4
|
description: Add a marketplace and install a plugin from it inside a Claude Code session, including the one-step form and the reload.
|
|
5
5
|
tags: [agents, claude-code]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
|
@@ -4,7 +4,6 @@ title: Updating and uninstalling Claude Code plugins
|
|
|
4
4
|
description: Auto-update is off by default for third-party marketplaces, so update by hand and reload; uninstall the plugin and remove the marketplace when you are done.
|
|
5
5
|
tags: [agents, claude-code]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
|
@@ -4,7 +4,6 @@ title: Installing from a script or CI
|
|
|
4
4
|
description: The claude plugin CLI installs and manages plugins from your shell, with user scope by default and a --yes flag for command-source prompts.
|
|
5
5
|
tags: [agents, claude-code, ci]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
{conventional_git-1.3.0 → conventional_git-2.2.0}/docs/agents/claude-code-skill-invocation.md
RENAMED
|
@@ -4,7 +4,6 @@ title: Invoking a Claude Code skill
|
|
|
4
4
|
description: The /<plugin>:<skill> slash form, automatic triggering by description, and three ways to verify a plugin skill is installed.
|
|
5
5
|
tags: [agents, claude-code, skills]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-skills
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
type: guideline
|
|
3
3
|
title: Install channels
|
|
4
4
|
description: Three ways to install agent skills today (the Claude Code marketplace, the npx skills CLI, and opencode's native skill tool) and what each delivers.
|
|
5
|
-
tags: [agents, install]
|
|
5
|
+
tags: [agents, install, toolchain]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
|
@@ -4,7 +4,6 @@ title: Installing skills with `npx skills`
|
|
|
4
4
|
description: npx skills add installs a repository's skills into one or more agent paths, symlinked by default, with flags for agent, scope, skill selection, and list-only.
|
|
5
5
|
tags: [agents, npx-skills]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: vercel-skills
|
|
@@ -4,7 +4,6 @@ title: Managing installed skills
|
|
|
4
4
|
description: npx skills list, update, and remove, plus find, use, and init, as shown by the CLI help.
|
|
5
5
|
tags: [agents, npx-skills]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: vercel-skills
|
|
@@ -4,7 +4,6 @@ title: opencode MCP configuration
|
|
|
4
4
|
description: The mcp key for local and remote servers, the config file precedence list, and the opencode mcp commands.
|
|
5
5
|
tags: [agents, opencode, mcp]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: opencode-mcp
|
|
@@ -4,7 +4,6 @@ title: opencode MCP server
|
|
|
4
4
|
description: Configure opencode to load the conventional-git MCP server via uvx, with copy-ready config snippets.
|
|
5
5
|
tags: [agents, opencode, mcp]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
sources:
|
|
9
8
|
- id: opencode-mcp
|
|
10
9
|
resource: https://opencode.ai/docs/mcp-servers/
|
|
@@ -4,7 +4,6 @@ title: opencode skill discovery
|
|
|
4
4
|
description: The project and global paths opencode reads skills from, the walk-up to the git worktree, and the name and description rules.
|
|
5
5
|
tags: [agents, opencode]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: opencode-skills
|
|
@@ -4,7 +4,6 @@ title: opencode skill permissions
|
|
|
4
4
|
description: permission.skill maps name patterns to allow, deny, or ask, and tools.skill false disables skills per agent.
|
|
5
5
|
tags: [agents, opencode]
|
|
6
6
|
status: stable
|
|
7
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
7
|
stale_after: 2027-03-29T00:00:00Z
|
|
9
8
|
sources:
|
|
10
9
|
- id: opencode-skills
|
|
@@ -5,7 +5,6 @@ description: The marketplace, plugin, and skill names for this project, plus the
|
|
|
5
5
|
resource: https://github.com/gajaguar/conventional-git
|
|
6
6
|
tags: [agents]
|
|
7
7
|
status: stable
|
|
8
|
-
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
9
8
|
sources:
|
|
10
9
|
- id: claude-discover-plugins
|
|
11
10
|
resource: https://code.claude.com/docs/en/discover-plugins
|
|
@@ -30,10 +29,12 @@ plugin, and skill names below match this repository's own
|
|
|
30
29
|
|
|
31
30
|
## Skills
|
|
32
31
|
|
|
33
|
-
| Skill
|
|
34
|
-
|
|
|
35
|
-
| `conventional-commit`
|
|
36
|
-
| `conventional-branch`
|
|
32
|
+
| Skill | Trigger phrasing |
|
|
33
|
+
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
|
|
34
|
+
| `conventional-commit` | `commit`, `conventional commit`, `create a commit`, `commit changes` (outside a gitmoji context) |
|
|
35
|
+
| `conventional-branch` | `create a branch`, `new branch`, `conventional branch`, `start working on`, `checkout a branch` (outside a ticket/module/team context) |
|
|
36
|
+
| `conventional-suggest` | `suggest a commit message`, `what should this commit be`, `draft a commit from the diff`, `use jev for the commit` |
|
|
37
|
+
| `conventional-auth` | `set up the jev key`, `login to TypeSafe`, `configure OpenRouter`, `check my suggestion credentials`, `remove my API key` |
|
|
37
38
|
|
|
38
39
|
## Prerequisites
|
|
39
40
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
type: rule
|
|
3
3
|
title: No CLAUDE.md check
|
|
4
4
|
description: make claude-md-check fails when a CLAUDE.md exists anywhere in the repository, because AGENTS.md is the only agent instructions file.
|
|
5
|
-
tags: [agents]
|
|
5
|
+
tags: [agents, documentation, makefile]
|
|
6
6
|
status: stable
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -7,7 +7,11 @@ Commit and branch naming.
|
|
|
7
7
|
own hooks.
|
|
8
8
|
* [Enforcing commits and branches](commits-check.md) - the pre-commit hook
|
|
9
9
|
and `make commits-check` that enforce them.
|
|
10
|
+
* [Versioning, tags and releases](versioning.md) - SemVer bump criteria, which
|
|
11
|
+
bumps get a tag, and on-demand releases.
|
|
10
12
|
* [Help-line check](help-check.md) - `make help-check` fails on a Makefile
|
|
11
13
|
target without a `##` help line.
|
|
12
14
|
* [No CLAUDE.md check](claude-md-check.md) - `make claude-md-check` fails
|
|
13
15
|
when a `CLAUDE.md` exists, since `AGENTS.md` is the only agent file.
|
|
16
|
+
* [Tag vocabulary](tag-vocabulary.md) - the tags the notes carry and what
|
|
17
|
+
each one means.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: reference
|
|
3
|
+
title: Tag vocabulary
|
|
4
|
+
description: The tags the docs/ notes carry and what each one means, which docs-retag reads as its questions.
|
|
5
|
+
tags: [documentation]
|
|
6
|
+
status: stable
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Tag vocabulary
|
|
10
|
+
|
|
11
|
+
Tags are cross-cutting: they name what a note is about, across directories. The
|
|
12
|
+
directory already names the topic. Every note here is about git, so `git` is not
|
|
13
|
+
a tag. The vocabulary is open: okflint accepts any tag, and a note may carry one
|
|
14
|
+
the table does not list, which `make docs-retag` never touches. A tag in the
|
|
15
|
+
table is one `make docs-retag` asks about, so add a row for each new tag worth
|
|
16
|
+
assigning that way.
|
|
17
|
+
|
|
18
|
+
A tag is lowercase and one word. Join words with a hyphen only when the
|
|
19
|
+
concept's own name has several words (a product, a tool or an established
|
|
20
|
+
term), and do not prefix a subtopic with its parent: `hooks`, not `git-hooks`.
|
|
21
|
+
|
|
22
|
+
| Tag | A note carries it when it… | A note does not when it… |
|
|
23
|
+
| :-------------- | :--------------------------------------------------------- | :------------------------------------------------------------- |
|
|
24
|
+
| `documentation` | is about how to write, structure or validate documentation | is about the product or the code rather than its documentation |
|
|
25
|
+
| `makefile` | is about a `make` target or the `Makefile` | does not concern the command surface |
|
|
26
|
+
| `release` | is about versions, tags that mark a release, or publishing | does not concern releasing |
|
|
27
|
+
| `toolchain` | is about which tool is installed, by whom and why | does not concern installing tools |
|
|
28
|
+
| `versioning` | is about SemVer and when to bump a version | does not concern version numbers |
|