pod docs dev commits.md
2.1 kB · 69 lines
Markdown
at main

Commit Conventions #

This project uses Conventional Commits with scoped messages.

Format #

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Scopes #

If any scope can reasonably be applied to a commit, it must be included. Multiple scopes are comma-separated:

feat(api, db): add card search endpoint
fix(api): correct pagination for large result sets

If no scope reasonably applies, it may be omitted:

chore: update dependencies
docs: fix typo in README

Types #

Type Purpose
feat A new feature
fix A bug fix
docs Documentation only changes
style Changes that do not affect the meaning of the code
refactor A code change that neither fixes a bug nor adds a feature
perf A code change that improves performance
test Adding or correcting tests
build Changes to the build system or external dependencies
ci Changes to CI configuration files and scripts
chore Other changes that don't modify src or test files
revert Reverts a previous commit

Breaking Changes #

Append ! after the type/scope to indicate a breaking change:

feat(api)!: remove deprecated endpoints

A BREAKING CHANGE: footer can provide additional detail:

feat(api)!: remove deprecated endpoints

BREAKING CHANGE: `/v1/cards` and `/v1/decks` have been removed.

Guidelines #

  • Use the imperative mood in the description ("add feature" not "added feature")
  • Keep the first line under 72 characters
  • Reference relevant issues in the footer (e.g., Closes #42)