commit-conventions

This skill should be used when writing commit messages, when asked about commit format, when reviewing a commit message, or when creating a git commit. Provides Conventional Commits format and project-specific conventions.

16 stars

Best use case

commit-conventions is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

This skill should be used when writing commit messages, when asked about commit format, when reviewing a commit message, or when creating a git commit. Provides Conventional Commits format and project-specific conventions.

Teams using commit-conventions should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/commit-conventions/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/backend/commit-conventions/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/commit-conventions/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How commit-conventions Compares

Feature / Agentcommit-conventionsStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

This skill should be used when writing commit messages, when asked about commit format, when reviewing a commit message, or when creating a git commit. Provides Conventional Commits format and project-specific conventions.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Commit Message Conventions

This project follows [Conventional Commits](https://www.conventionalcommits.org/).

## Format

```
{type}({optional-scope}): {subject}

{optional body}

{optional footer}
```

## Types

| Type | When to Use |
|---|---|
| `feat` | New feature or user-visible capability |
| `fix` | Bug fix |
| `refactor` | Code change that neither adds a feature nor fixes a bug |
| `test` | Adding or modifying tests only |
| `docs` | Documentation changes only |
| `chore` | Build system, tooling, dependency updates |
| `perf` | Performance improvement |
| `ci` | CI/CD pipeline changes |
| `style` | Formatting only — no logic change |

## Subject Line Rules

- Imperative mood: "add feature" not "added" or "adding"
- Lowercase first letter
- No period at the end
- Max 72 characters
- Be specific: "fix null pointer in UserService.getById" not "fix bug"

## Scope (optional)

Identifies the part of the codebase affected. Use the feature or module name:
- `feat(auth): add OAuth2 login`
- `fix(payment): handle timeout on charge API`
- `chore(deps): update riverpod to 2.5.0`

## Body

Explain the **why**, not the what. The diff shows what changed.

```
fix(auth): handle expired session tokens on app resume

Previously, the app silently failed on resume when the session token
had expired, leaving users on a blank screen. Now we detect expiry
on AppLifecycleState.resumed and redirect to the login screen.

Closes #234
```

## Breaking Changes

Add `BREAKING CHANGE:` in the footer:

```
feat(api)!: remove deprecated v1 endpoints

BREAKING CHANGE: /api/v1/* endpoints removed. Migrate to /api/v2/*.
See migration guide in docs/api-migration.md
```

The `!` after the type also signals a breaking change.

## Footer Keywords

- `Closes #123` — closes a GitHub issue on merge
- `Fixes #123` — same as Closes
- `Related to #123` — links without closing
- `Co-authored-by: Name <email>` — multiple authors

## Examples

```
feat(checkout): add Apple Pay support

fix(ui): prevent keyboard overlap on login form

refactor(data): extract UserMapper from UserRepository

test(auth): add integration tests for token refresh flow

chore(deps): bump flutter to 3.19.0
```

## What to Avoid

- "WIP", "fix", "update", "changes" — too vague
- Commit messages describing only the diff ("add null check")
- Past tense ("added feature X")
- Very long subject lines (use the body instead)

Related Skills

entity-class-conventions

16
from diegosouzapw/awesome-omni-skill

Sets the standards for entity class design including annotations, ID generation strategies, and relationship configurations for database interaction.

adversarial-committee

16
from diegosouzapw/awesome-omni-skill

Committee of personas with opposing propensities forcing genuine debate

push-commit

16
from diegosouzapw/awesome-omni-skill

Stage all changes, commit with a descriptive message, and push to the remote. Trigger with "push commit", "commit and push", "push changes", "/push-commit".

git-create-commit-skill

16
from diegosouzapw/awesome-omni-skill

Use when creating git commits - mandates commits format with required scopes for all new commits, provides scope discovery from codebase structure, and prevents rationalization under pressure (emergency, fatigue, ambiguity)

git-commit-push

16
from diegosouzapw/awesome-omni-skill

This skill should be used when the user wants to commit their work to git and push to GitHub. It guides through reviewing changes, crafting meaningful commit messages following project conventions (including Conventional Commits when detected), creating commits with security checks, and pushing to remote repositories.

Git Commit Helper

16
from diegosouzapw/awesome-omni-skill

Creates well-formatted conventional commits with intelligent change analysis. Use when creating commits, committing changes, staging files, or when the user mentions "commit", "git commit", or wants to save their work to version control. Analyzes diffs to suggest splitting commits when multiple concerns are detected.

commit

16
from diegosouzapw/awesome-omni-skill

diff分析 → 論理的に分割コミット。conventional commitメッセージを自動生成。

commit-quick

16
from diegosouzapw/awesome-omni-skill

codemapの更新をスキップして素早くgit commitする。変更内容を分析し、適切なコミットメッセージを自動生成してコミットを作成する。

restcontroller-conventions

16
from diegosouzapw/awesome-omni-skill

Specifies standards for RestController classes, including API route mappings, HTTP method annotations, dependency injection, and error handling with ApiResponse and GlobalExceptionHandler.

commit-feature

16
from diegosouzapw/awesome-omni-skill

Stage changes, create conventional commit (no co-author), push to origin, and add detailed PR comment with session context

commit-assistant

16
from diegosouzapw/awesome-omni-skill

Provides conventional commits guidance and auto-generates commit messages from git changes. Integrates with /ccpm:commit for automated git commits linked to Linear issues. Auto-activates when users ask about committing, creating git commits, or discussing commit message formats.

api-route-conventions

16
from diegosouzapw/awesome-omni-skill

Expert knowledge on Next.js API route patterns, authentication with getAuthOrTest, error handling, response formats, rate limiting, and webhook verification. Use this skill when user asks about "create api endpoint", "api route", "error handling", "authentication", "next.js api", or "route handler".