Commit

Conventional Commit Messages

Follow these conventions when creating commits for this project.

Prerequisites

Before committing, always check the current branch:

git branch --show-current

If you're on main or master, confirm with the user before committing directly — it is usually better to commit on a feature branch. Do not create a branch without user confirmation.

Before claiming the change is ready to commit, use verification-before-completion:

• Identify the exact readiness claim for the commit.
• Run the relevant project checks, or state exactly why they cannot be run.
• Inspect git diff --stat / changed files so the commit scope is known.
• Do not say "ready to commit" if verification is partial or failed.

Format

(): 

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

Commit Types

| Type | Purpose | |------|---------| | feat | New feature | | fix | Bug fix | | ref | Refactoring (no behavior change) | | perf | Performance improvement | | docs | Documentation only | | test | Test additions or corrections | | build | Build system or dependencies | | ci | CI configuration | | chore | Maintenance tasks | | style | Code formatting (no logic change) | | meta | Repository metadata | | license | License changes |

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

Footer: Issue References

Reference issues in the footer using these patterns:

Fixes #1234
Refs #1234
Refs LINEAR-ABC-123

• Fixes closes the issue when merged
• Refs links without closing

AI-Generated Changes

When changes were primarily generated by a coding agent (like Claude Code), include the Co-Authored-By attribution in the commit footer:

Co-Authored-By: Claude 

This is the only indicator of AI involvement that should appear in commits. Do not add phrases like "Generated by AI", "Written with Claude", or similar markers in the subject, body, or anywhere else in the commit message.

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.

Fixes #5678
Co-Authored-By: Claude 

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.

Refs GH-1234

Refactor

ref: 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
Fixes #9999

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

• Conventional Commits

Related Skills

• verification-before-completion - Required before commit readiness claims.

When to Use

• Use when ALWAYS use this skill when committing code changes — never commit directly without it. Creates commits with proper conventional commit format and issue references. Trigger on any commit, git commit, save changes, or commit message task.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: tranhieutt
• Source: tranhieutt/softwaredevelopment_department
• License: MIT

Install and usage instructions live in the source repository linked above.