Agent skill

git-conventions

Apply when committing code, writing commit messages, or configuring .gitignore

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/git-conventions-karstenheld3-openai-backendtools

SKILL.md

Git Conventions

Verb Mapping

This skill implements:

  • [COMMIT] - Create conventional commits
  • [MERGE] - Merge branches following conventions

Phases: IMPLEMENT, DELIVER

MUST-NOT-FORGET

  • Use Conventional Commits: <type>(<scope>): <description>
  • Types: feat, fix, docs, refactor, test, chore, style, perf
  • Imperative mood, <72 chars, no period
  • NEVER commit secrets: .env, *.cer, *.pfx, *.pem, *.key

Commit Message Format

Use Conventional Commits: <type>(<scope>): <description>

Types

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • refactor: Code change that neither fixes a bug nor adds a feature
  • test: Adding or updating tests
  • chore: Maintenance tasks, dependencies, build changes
  • style: Formatting, whitespace (no code logic change)
  • perf: Performance improvement

Guidelines

  1. Use imperative mood ("add" not "added" or "adds")
  2. Keep description under 72 characters
  3. No period at the end
  4. Scope should match module/folder name when applicable

Examples

feat(crawler): add incremental crawl mode
fix(auth): handle expired tokens
docs: update README installation steps
refactor(domains): simplify source validation logic
chore: update dependencies to latest versions

.gitignore Rules

  1. NEVER commit secrets: .env files, certificates (*.cer, *.pfx, *.pem, *.key), API keys
  2. Exclude large binaries: Reinstallable tools (poppler, node_modules, .venv/) - save repo size
  3. Exclude build artifacts: Generated files (dist/, pycache/, *.pyc)
  4. Track shared config: .vscode/, Set-*-Env.bat (environment setup scripts)
  5. Use negation pattern: Keep specific files with ! prefix when excluding folders
  6. Add comments: Document non-obvious exclusions in .gitignore

Template

gitignore
# Secrets (NEVER commit)
*.env
.env.*
*.cer
*.pfx
*.pem
*.key

# Python
.venv/
__pycache__/
*.pyc
.pytest_cache/
.mypy_cache/

# Node.js
node_modules/
dist/
lib/
*.log

# IDE (keep .vscode/)
.vs/
bin/
obj/

# OS
.DS_Store

# Tools (reinstallable)
.tools/poppler/

# Temporary
*.tmp
.tmp_*
*.bak

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results