Skip to content

Clarify git management policy for .claude/commands/hermit*.md files #91

Description

@ytnobody

Background

Running hermit install (or hermit serve) generates the following files in a project's .claude/commands/ directory:

  • .claude/commands/hermit.md
  • .claude/commands/hermit-pause.md
  • .claude/commands/hermit-resume.md

It is currently unclear whether these files should be committed to version control in projects that use HERMIT.

Problem

Users have no guidance on whether to commit these generated files. This creates inconsistency across projects:

  • If committed: team members sharing the repo get the slash commands automatically, but updates to hermit's templates may cause conflicts or drift
  • If not committed: each developer must re-run hermit install after cloning, and there is no indication they need to do so

Proposed Decision

Commit these files to version control. Rationale:

  1. They are project-scoped slash commands (.claude/commands/) — Claude Code treats them as project configuration, similar to CLAUDE.md
  2. Other contributors using Claude Code on the same project should have access to /hermit, /hermit-pause, /hermit-resume without manual setup
  3. The content is intentionally project-specific (the hermit.md body references project context) and may legitimately differ per repo
  4. They are small, human-readable markdown files with no secrets

Action Items

  • Add a note to the README (Installation / Quick Start section) explicitly stating that .claude/commands/hermit*.md should be committed to the project repository
  • Optionally: have hermit install print a reminder to git add .claude/commands/ after generating the files
  • Optionally: update .gitignore template (if one is generated) to ensure these files are not excluded

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions