Skip to content

commit-guide skill is hardcoded to a VitePress site — emits wrong version-bump guidance in other repos #22

Description

@VirtueMe

Problem

The commit-guide skill's "Determine commit type" section is written for a specific VitePress documentation site. It hardcodes assumptions that don't hold in other projects the plugin is used in:

  • A version-bump table keyed on "VitePress site changes only" (feat → minor, fix/style → patch).
  • A worked example about a footer org number / MVA (VAT) registration.
  • Guidance that style: / fix: commits "trigger a version bump and site deployment."

In a repo with no package.json, no VitePress, and no semantic-release (e.g. a bash CLI / orchestration project), this makes the skill assert a version bump and deploy that will never happen. Observed live: while committing in such a repo the skill surfaced "⚠️ This is a feat: — triggers a … version bump and site deployment," which is simply false there. The user had to catch it.

Suggested fix

Decouple the commit-type taxonomy from the release mechanism:

  1. Keep the conventional-commit type rules (feat/fix/docs/chore/refactor/ci/test/style) — those are project-agnostic and useful everywhere.
  2. Make the version-bump / deploy note conditional: only surface it when the repo actually has a release pipeline (detect e.g. package.json + semantic-release config, or a release workflow). Otherwise state plainly that commit type drives history only, no automated bump.
  3. Drop the VitePress-specific example (footer/MVA) or replace it with a neutral one.

Notes

  • Surfaced while using the plugin in VirtueMe/conductor-swarm-forge (a no-release bash project); see that repo's PR #43 discussion.
  • Low risk: the fix is to the skill's prose/conditionals, not to commit behaviour.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions