OpenParable
Skip to content
← Back to skills

Commit Convention

Development
commit-convention

Commit Convention is an Agent Skill for development published in the modiqo/skillspec repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when writing commit messages, creating PR titles, pushing commits, or creating PRs — ensures conventional commit format and that formatting/linting pass before any push

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/modiqo/skillspec/blob/HEAD/.claude/skills/commit-convention/source/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/commit-convention, 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.

Commit Convention

This project uses Conventional Commits. PR titles are linted by CI and become the squash-merge commit message on main.

Pre-push Gate

Before pushing commits or creating a PR, run both checks and confirm they pass:

cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features -- -D warnings

If either fails, fix the issues and amend/re-commit before pushing. Only skip these checks if the plan explicitly allows for it.

Format

<type>[optional scope]: <description>

Allowed Types

  • feat — new feature
  • fix — bug fix
  • docs — documentation only
  • style — formatting, no code change
  • refactor — neither fix nor feature
  • perf — performance improvement
  • test — adding or updating tests
  • build — build system or dependencies
  • ci — CI configuration
  • chore — maintenance tasks
  • revert — revert a previous commit

Rules

  • Subject must NOT start with an uppercase letter
  • Scope is optional and freeform (e.g., feat(adapter): ...)
  • Breaking changes: use ! after type (e.g., feat!: ...) or add BREAKING CHANGE: footer

Examples

feat: add semantic search for skills
fix(grpc): handle timeout on large payloads
ci: add conventional commits PR title linting
feat!: redesign adapter API