explainx.ainewsletter3.4k
Productivity

conventional-commit▌

marcelorodrigo/agent-skills · updated May 25, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/marcelorodrigo/agent-skills --skill conventional-commit
0 commentsdiscussion
summary

Structured commit message format following the Conventional Commits specification.

  • ›Defines 12 commit types (feat, fix, refactor, docs, test, chore, ci, build, perf, style, deps, revert) with clear purposes and semantic versioning correlation
  • ›Enforces a required header format with optional scope and body, all lines under 100 characters, subject line capped at 70 characters
  • ›Includes guidelines for imperative present-tense language, body content explaining what and why, and support for
skill.md

Conventional Commit Messages

Follow these conventions when creating commits.

Prerequisites

Before committing, ensure you're working on a feature branch, not the main branch.

# Check current branch
git branch --show-current

If you're on main or master, create a new branch first:

# Create and switch to a new branch
git checkout -b <type>/<short-description>

Branch naming should follow the pattern: <type>/<short-description> where type matches the commit type (e.g., feat/add-user-auth, fix/null-pointer-error, refactor/extract-validation).

Format

<type>(<scope>): <subject>

<body>

<footer>

The header is required. Scope is optional. All lines must stay under 100 characters.

Commit Types

Type Purpose
build Build system or CI changes
chore Routine maintenance tasks
ci Continuous integration configuration
deps Dependency updates
docs Documentation changes
feat New feature
fix Bug fix
perf Performance improvement
refactor Code refactoring (no behavior change)
revert Revert a previous commit
style Code style and formatting
test Tests added, updated or improved

Subject Line Rules

  • Use imperative, present tense: "Add feature" not "Added feature"
  • Capitalize the first letter
  • No period at the end
  • Maximum 70 characters

Body Guidelines

  • Explain what and why, not how
  • Use imperative mood and present tense
  • Include motivation for the change
  • Contrast with previous behavior when relevant

Conventional Commits

The commit contains the following structural elements, to communicate intent to the consumers of your library:

  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
  • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
  • BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
  • types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
  • footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.

Examples

Simple fix

fix(api): Handle null response in user endpoint

The user API could return null for deleted accounts, causing a crash
in the dashboard. Add null check before accessing user properties.

Feature with scope

feat(alerts): Add Slack thread replies for alert updates

When an alert is updated or resolved, post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped together.

Refactor

refactor: Extract common validation logic to shared module

Move duplicate validation code from three endpoints into a shared
validator class. No behavior change.

Breaking change

feat(api)!: Remove deprecated v1 endpoints

Remove all v1 API endpoints that were deprecated in version 23.1.
Clients should migrate to v2 endpoints.

BREAKING CHANGE: v1 endpoints no longer available

Revert Format

revert: feat(api): Add new endpoint

This reverts commit abc123def456.

Reason: Caused performance regression in production.

Principles

  • Each commit should be a single, stable change
  • Commits should be independently reviewable
  • The repository should be in a working state after each commit

References

how to use conventional-commit

How to use conventional-commit on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • ›Cursor installed and configured on your development machine
  • ›Node.js version 16.0+ with npm package manager (verify with node --version)
  • ›Active project directory or workspace where you want to add conventional-commit
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/marcelorodrigo/agent-skills --skill conventional-commit

The skills CLI fetches conventional-commit from GitHub repository marcelorodrigo/agent-skills and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/conventional-commit

Reload or restart Cursor to activate conventional-commit. Access the skill through slash commands (e.g., /conventional-commit) or your agent's skill management interface.

⚠

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

Additional Resources

›View source code on GitHub›Skills CLI documentation›Learn more about Cursor›What are agent skills?

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases▌

User Story & Requirements Generation

Create detailed user stories, acceptance criteria, and feature specs

Example

Generate user stories for 'password reset feature' with acceptance criteria, edge cases, and test scenarios

✓

Reduce spec writing time by 50%, ensure comprehensive coverage

Competitive Analysis

Research competitors, compare features, identify gaps

Example

Analyze 5 competitor products, create feature comparison matrix, suggest differentiation opportunities

✓

Complete competitive research in 2 hours instead of 2 days

Roadmap Prioritization

Evaluate features using frameworks (RICE, ICE, Kano) and create prioritized backlogs

Example

Score 20 feature ideas using RICE framework, generate prioritized roadmap with rationale

✓

Make data-driven prioritization decisions faster

Stakeholder Communication

Draft PRDs, status updates, and stakeholder presentations

Example

Create executive summary of Q3 roadmap, monthly progress report, feature launch announcement

✓

Save 3-5 hours/week on communication overhead

Implementation Guide▌

Prerequisites

  • ›Claude Desktop or compatible AI client
  • ›Access to product documentation and roadmap tools (Jira, Notion, etc.)
  • ›Understanding of product management frameworks (RICE, Jobs-to-be-Done, etc.)
  • ›Stakeholder contact information and communication channels

Time Estimate

30-60 minutes to see productivity improvements

Installation Steps

  1. 1.Install product management skill
  2. 2.Start with user story generation for known feature
  3. 3.Progress to competitive analysis: research 2-3 competitors
  4. 4.Use for roadmap prioritization: apply RICE/ICE scoring
  5. 5.Draft stakeholder communications and refine based on feedback
  6. 6.Build template library for recurring PM tasks
  7. 7.Share effective prompts with product team

Common Pitfalls

  • ⚠Not validating competitive research—verify facts before sharing
  • ⚠Accepting user stories without involving engineering team
  • ⚠Over-relying on frameworks without qualitative judgment
  • ⚠Not customizing outputs to company culture and communication style
  • ⚠Skipping stakeholder validation of generated requirements

Best Practices▌

✓ Do

  • +Validate research and competitive analysis with real data
  • +Collaborate with engineering when generating technical requirements
  • +Customize frameworks and templates to your company context
  • +Use skill for first drafts, refine with stakeholder input
  • +Document successful prompt patterns for PM tasks
  • +Combine AI efficiency with human judgment and intuition

✗ Don't

  • −Don't publish competitive analysis without fact-checking
  • −Don't finalize user stories without engineering review
  • −Don't make prioritization decisions solely on AI scoring
  • −Don't skip customer validation of generated requirements
  • −Don't ignore company-specific context and culture

💡 Pro Tips

  • ★Provide context: company goals, constraints, customer feedback
  • ★Ask for alternatives: 'Show 3 ways to prioritize this roadmap'
  • ★Request stakeholder-specific formatting: 'Executive summary vs. engineering spec'
  • ★Use skill for 70% generation + 30% customization to company needs

When to Use This▌

✓ Use When

Use for user story writing, competitive research, roadmap prioritization, stakeholder communication, and PRD drafting. Best for reducing repetitive documentation and research work.

✗ Avoid When

Avoid for strategic product vision (requires deep customer empathy), pricing decisions (needs market and financial expertise), or when face-to-face customer discovery is more valuable than speed.

Learning Path▌

  1. 1Basic: user stories, feature specs, status updates
  2. 2Intermediate: competitive analysis, prioritization frameworks, PRDs
  3. 3Advanced: product strategy, go-to-market planning, OKR setting
  4. 4Expert: product vision, market positioning, business model innovation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.7★★★★★56 reviews
  • ★★★★★Emma Bansal· Dec 24, 2024

    conventional-commit has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • ★★★★★Xiao Chawla· Dec 24, 2024

    conventional-commit reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • ★★★★★Li Huang· Dec 24, 2024

    Useful defaults in conventional-commit — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • ★★★★★Kofi Desai· Dec 8, 2024

    We added conventional-commit from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • ★★★★★Shikha Mishra· Dec 4, 2024

    I recommend conventional-commit for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • ★★★★★Aditi Sanchez· Dec 4, 2024

    Solid pick for teams standardizing on skills: conventional-commit is focused, and the summary matches what you get after install.

  • ★★★★★Amina Gupta· Nov 27, 2024

    Useful defaults in conventional-commit — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • ★★★★★Rahul Santra· Nov 23, 2024

    Solid pick for teams standardizing on skills: conventional-commit is focused, and the summary matches what you get after install.

  • ★★★★★Li Chen· Nov 23, 2024

    I recommend conventional-commit for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • ★★★★★Henry Smith· Nov 15, 2024

    Registry listing for conventional-commit matched our evaluation — installs cleanly and behaves as described in the markdown.

showing 1-10 of 56

1 / 6