augmnt/webdev-skills

writing-commits

Generates commit messages and PR descriptions following Conventional Commits.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/augmnt/webdev-skills --skill writing-commits

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

Writing Commits

Follow Conventional Commits: <type>(<scope>): <subject>

Types

TypeUse For
featNew user-facing feature
fixBug fix
docsDocumentation only
refactorCode change, no behavior change
testAdding/fixing tests
choreBuild, deps, tooling

Rules

  1. Subject: imperative mood, no period, ≤50 chars
  2. Scope: optional area indicator (auth, api, ui)
  3. Breaking changes: add ! after type

Examples

bash
feat(auth): add Google OAuth login
fix(api): handle null user in profile endpoint
feat(api)!: change auth response format
chore(deps): upgrade Next.js to 15

Anti-patterns

bash
# ❌ Avoid
"fix stuff"
"updates"
"WIP"

# ✅ Prefer
"fix(auth): resolve token refresh race condition"

PR Titles

Same format as commits. PR title becomes the squash commit message.

PR Body

markdown
## What
[Brief description]

## Why
[Context/motivation]

## Testing
[How verified]

Branch Naming

bash
# Format: type/short-description
feat/oauth-login
fix/token-refresh
chore/upgrade-deps

# With ticket numbers
feat/PROJ-123-oauth-login
fix/PROJ-456-token-refresh

Keep branches short-lived. Delete after merge.

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills