菜单
Git conventions covering branch naming, conventional commits, PR format, squash strategy, and protected branches. Use when committing, branching, opening PRs, or setting up a git workflow for a project.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
REST API conventions covering URL structure, HTTP methods, status codes, pagination, filtering, error responses, and versioning. Use when designing or reviewing REST API endpoints, adding routes, or standardizing API error handling.
React best practices covering functional components, hooks, state management, performance, and accessibility. Use when writing or reviewing React components, hooks, or state logic.
Testing approach covering unit/integration/e2e split, what to test, AAA test structure, mocking strategies, and coverage targets. Use when writing tests, planning test coverage, or reviewing test quality.
Strict TypeScript conventions covering strict mode config, no-any rules, utility types, discriminated unions, branded types, and error handling patterns. Use when writing TypeScript, tightening types, or migrating code to strict mode.
| name | git-workflow |
| description | Git conventions covering branch naming, conventional commits, PR format, squash strategy, and protected branches. Use when committing, branching, opening PRs, or setting up a git workflow for a project. |
Git conventions: branch naming, conventional commits, PR format, squash strategy, and protected branches.
Use the format: <type>/<ticket>-<short-description>
| Type | Purpose | Example |
|---|---|---|
feat/ | New feature | feat/PROJ-123-user-avatars |
fix/ | Bug fix | fix/PROJ-456-login-redirect |
chore/ | Maintenance, deps, config | chore/upgrade-react-19 |
docs/ | Documentation only | docs/api-authentication-guide |
refactor/ | Code restructuring | refactor/extract-auth-module |
test/ | Adding or fixing tests | test/order-service-coverage |
hotfix/ | Urgent production fix | hotfix/payment-timeout |
main (or develop if using Git Flow)Follow the Conventional Commits specification.
<type>(<scope>): <subject>
<body>
<footer>
| Type | When to Use |
|---|---|
feat | New feature visible to users |
fix | Bug fix |
docs | Documentation changes only |
style | Formatting, whitespace (no logic changes) |
refactor | Code change that neither fixes a bug nor adds a feature |
perf | Performance improvement |
test | Adding or updating tests |
build | Build system or dependencies |
ci | CI/CD pipeline changes |
chore | Other changes that don't modify src or test files |
revert | Reverts a previous commit |
feat(auth): add OAuth2 login with Google
Adds Google OAuth2 as a login option alongside email/password.
Users can link their Google account in settings.
Closes #234
---
fix(cart): prevent duplicate items on rapid clicks
Added debounce to the "Add to Cart" button and server-side
idempotency check using the request ID header.
Fixes #567
---
feat(api)!: change pagination from offset to cursor-based
BREAKING CHANGE: The `page` and `per_page` query parameters are
replaced by `cursor` and `limit`. See migration guide in docs.
Use the same format as conventional commits:
feat(auth): add OAuth2 login with Google
## Summary
Brief description of what changed and why.
## Changes
- First change
- Second change
- Third change
## Testing
- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] Manual testing completed
## Screenshots
(if UI changes)
## Related
Closes #123
Use squash merge for feature branches:
mainmain into a feature branch -- to stay up to datemain to get a clean diffmain branch rulesmaindevelop branch rules (if using Git Flow)v1.2.3main -- after the merge# Create a release tag
git tag -a v1.2.3 -m "Release v1.2.3"
git push origin v1.2.3
1. Create branch git checkout -b feat/PROJ-123-user-avatars main
2. Make commits git commit -m "feat(users): add avatar upload"
3. Push branch git push -u origin feat/PROJ-123-user-avatars
4. Open PR gh pr create --title "feat(users): add avatar upload"
5. Review cycle Address feedback, push fixes
6. Squash merge Merge via GitHub UI
7. Delete branch git branch -d feat/PROJ-123-user-avatars
8. Pull main git checkout main && git pull
main directly -- always use a branch and PR