OpenParable
Skip to content
← Back to skills

Write Git Commit

Development
write-git-commit

Write Git Commit is an Agent Skill for development published in the jamiebrynes7/obsidian-todoist-plugin repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create a git commit following repository conventions

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/jamiebrynes7/obsidian-todoist-plugin/blob/HEAD/.claude/skills/write-git-commit/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/write-git-commit, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Git Commit

Create git commits following the repository's established conventions.

Commit Message Format

<scope>: <subject>

[optional body]

Scope

The scope indicates which part of the codebase is affected:

  • plugin - Plugin source code changes (most common)
  • docs - Documentation changes
  • scripts - Build/release script changes
  • .github - GitHub workflows and actions
  • .claude - Claude configuration and skills
  • .vscode - VS Code settings
  • * - Changes spanning multiple packages/areas

For focused changes within a scope, you may use a more specific prefix like plugin api, plugin settings, etc.

Subject Line

  • Use lowercase after the colon
  • Use imperative mood ("add feature" not "added feature")
  • No period at the end
  • Keep concise (ideally under 72 characters total)

Examples:

  • plugin: add support for task filtering
  • docs: update query-blocks documentation
  • *: bump versions across the board
  • .github: add separate build job

Body (Optional)

  • Separate from subject with a blank line
  • Explain why the change was made, not what
  • Use sparingly - only when the subject isn't self-explanatory

Example:

plugin: restore react & react-dom dedupe

While the tests pass after aligning react versions between docs/ and
plugin/, the build still breaks at runtime without this.

DO NOT add Claude as a coauthor to the commit.

Process

  1. Run git status to see staged and unstaged changes
  2. Run git diff --staged to review what will be committed
  3. Stage files with git add <files> (prefer specific files over git add -A)
  4. Determine the appropriate scope based on changed files
  5. Write a clear, concise subject line
  6. Add a body only if the "why" isn't obvious
  7. Create the commit