mirror of https://github.com/rustfs/console.git synced 2026-10-31 20:58:27 +08:00

Files

T

overtrue 9001300b96 docs: add commit message English requirement to contribution guidelines

- Add requirement that all commit messages must be in English
- Update README.md with examples of correct/incorrect commit messages
- Update .github/README.md with commit message guidelines
- Add commit message check to PR template

2025-10-31 23:56:51 +08:00

3.4 KiB

Raw Blame History

📝 Pull Request

📋 Description

🔄 Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
📚 Documentation update
🔧 Code refactoring
⚡ Performance improvement
🧪 Test improvements
🔒 Security fix

🧪 Testing

Test Coverage

Unit tests added/updated
Integration tests added/updated
Performance tests added/updated
Manual testing completed

Test Results

# 运行测试的命令和结果
npm run test

📊 Performance Impact

No performance impact
Performance improved
Performance impact analyzed and acceptable
Performance benchmarks included

🔒 Security Considerations

No security impact
Security review completed
Vulnerability assessment done
Security tests added

📚 Documentation

Code comments updated
README updated (if needed)
API documentation updated (if needed)
Changelog updated

✅ Checklist

Code Quality

Code follows the project's style guidelines
Self-review of the code completed
Code is properly commented
No console.log or debug statements left
TypeScript types are properly defined
All commit messages are in English (following Conventional Commits)

Testing

All existing tests pass
New tests cover the changes
Test coverage is maintained or improved
Edge cases are tested

Dependencies

No new dependencies added, or they are justified
Dependencies are up to date
No security vulnerabilities in dependencies

Compatibility

Changes are backward compatible
Browser compatibility maintained
Node.js version compatibility maintained

Closes # Fixes # Related to #

📸 Screenshots (if applicable)

Before	After

🚀 Deployment Notes

No special deployment steps required
Database migration required
Configuration changes required
Environment variables updated

👥 Reviewers

Please review: @

📝 Additional Notes

🤖 Automated Checks

The following checks will be automatically performed:

✅ Code formatting (Prettier)
✅ Type checking (TypeScript)
✅ Linting (ESLint)
✅ Unit tests
✅ Integration tests
✅ Security scan
✅ Performance tests
✅ Build verification

📊 Code Coverage

Current coverage will be displayed here after the tests run.

⚡ Performance Benchmarks

Performance impact will be analyzed and displayed here.

3.4 KiB Raw Blame History