红尘
d73ff9b0fb
Deploy Site / deploy-vercel (push) Has been cancelled
Deploy Site / deploy-docs (push) Has been cancelled
Docker / shell lint / Lint Dockerfile (hadolint) (push) Has been cancelled
Docker / shell lint / Lint docker/ shell scripts (shellcheck) (push) Has been cancelled
Docker Build and Publish / build-amd64 (push) Has been cancelled
Docker Build and Publish / build-arm64 (push) Has been cancelled
Lint (ruff + ty) / ruff + ty diff (push) Has been cancelled
Lint (ruff + ty) / ruff enforcement (blocking) (push) Has been cancelled
Lint (ruff + ty) / Windows footguns (blocking) (push) Has been cancelled
Nix Lockfile Fix / auto-fix-main (push) Has been cancelled
Nix Lockfile Fix / fix (push) Has been cancelled
Nix / nix (macos-latest) (push) Has been cancelled
Nix / nix (ubuntu-latest) (push) Has been cancelled
OSV-Scanner / Scan lockfiles (push) Has been cancelled
Build Skills Index / build-index (push) Has been cancelled
Tests / test (1) (push) Has been cancelled
Tests / test (2) (push) Has been cancelled
Tests / test (3) (push) Has been cancelled
Tests / test (4) (push) Has been cancelled
Tests / test (5) (push) Has been cancelled
Tests / test (6) (push) Has been cancelled
Tests / e2e (push) Has been cancelled
uv.lock check / uv lock --check (push) Has been cancelled
Docker Build and Publish / merge (push) Has been cancelled
Build Skills Index / trigger-deploy (push) Has been cancelled
Tests / save-durations (push) Has been cancelled
2.4 KiB
2.4 KiB
Conventional Commits Quick Reference
Format: type(scope): description
Types
| Type | When to use | Example |
|---|---|---|
feat |
New feature or capability | feat(auth): add OAuth2 login flow |
fix |
Bug fix | fix(api): handle null response from /users endpoint |
refactor |
Code restructuring, no behavior change | refactor(db): extract query builder into separate module |
docs |
Documentation only | docs: update API usage examples in README |
test |
Adding or updating tests | test(auth): add integration tests for token refresh |
ci |
CI/CD configuration | ci: add Python 3.12 to test matrix |
chore |
Maintenance, dependencies, tooling | chore: upgrade pytest to 8.x |
perf |
Performance improvement | perf(search): add index on users.email column |
style |
Formatting, whitespace, semicolons | style: run black formatter on src/ |
build |
Build system or external deps | build: switch from setuptools to hatch |
revert |
Reverts a previous commit | revert: revert "feat(auth): add OAuth2 login flow" |
Scope (optional)
Short identifier for the area of the codebase: auth, api, db, ui, cli, etc.
Breaking Changes
Add ! after type or BREAKING CHANGE: in footer:
feat(api)!: change authentication to use bearer tokens
BREAKING CHANGE: API endpoints now require Bearer token instead of API key header.
Migration guide: https://docs.example.com/migrate-auth
Multi-line Body
Wrap at 72 characters. Use bullet points for multiple changes:
feat(auth): add JWT-based user authentication
- Add login/register endpoints with input validation
- Add User model with argon2 password hashing
- Add auth middleware for protected routes
- Add token refresh endpoint with rotation
Closes #42
Linking Issues
In the commit body or footer:
Closes #42 ← closes the issue when merged
Fixes #42 ← same effect
Refs #42 ← references without closing
Co-authored-by: Name <email>
Quick Decision Guide
- Added something new? →
feat - Something was broken and you fixed it? →
fix - Changed how code is organized but not what it does? →
refactor - Only touched tests? →
test - Only touched docs? →
docs - Updated CI/CD pipelines? →
ci - Updated dependencies or tooling? →
chore - Made something faster? →
perf