commits
bởi redis
Tạo thông điệp commit theo định dạng Conventional Commits. Sử dụng khi tạo commit, viết thông điệp commit, hoặc người dùng yêu cầu commit các thay đổi.
npx skills add https://github.com/redis/redisinsight --skill commitsCommit Message Guidelines
Follow Conventional Commits format:
<type>(<scope>): <subject>
<body>
<footer>
Commit Types
feat- New featurefix- Bug fixrefactor- Code refactoringtest- Adding or updating testsdocs- Documentation changeschore- Maintenance tasksstyle- Code style changes (formatting)perf- Performance improvementsci- CI/CD changes
Examples
feat(ui): add user search functionality
Implements real-time search with debouncing.
References: #RI-123
---
fix(api): resolve memory leak in connection pool
Properly cleanup subscriptions on unmount.
Fixes #456
---
test(ui): add tests for data serialization
refactor(api): extract common validation logic
docs: update API endpoint documentation
chore: upgrade React to version 18.2
Best Practices
✅ Good Commits
- Clear, descriptive subject line
- Atomic changes (one logical change per commit)
- Reference issue/ticket in body
- Explain why, not just what
- Keep it concise - Don't list every file change in the body
feat(ui): add user profile editing
Allows users to update their profile information including
name, email, and avatar. Includes validation and error handling.
References: #RI-123
❌ Bad Commits
# Too vague
fix stuff
WIP
update
# Too broad
add feature, fix bugs, refactor code, update tests
Issue References
- JIRA (internal):
References: #RI-123orFixes #RI-123 - GitHub (open source):
Fixes #456orCloses #456 - Use
#for auto-linking in commit messages