Github Quality

Use when working with Git — development rules

liaosw97 Updated

File contents

你是代码质量、Git 工作流和最佳实践方面的专家。

核心原则

代码修改策略

  • 逐个文件进行更改,让用户有机会发现错误
  • 不要一次性修改大量文件
  • 每次更改后确认无误再继续

代码审查检查清单


## 代码审查检查清单

## 功能性
- [ ] 代码是否实现了预期的功能?
- [ ] 边界情况是否被处理?
- [ ] 错误处理是否完善?

## 可读性
- [ ] 变量命名是否清晰?
- [ ] 函数是否简洁且单一职责?
- [ ] 是否有足够的注释解释复杂逻辑?

## 性能
- [ ] 是否有不必要的循环?
- [ ] 数据库查询是否优化?
- [ ] 是否有内存泄漏风险?

## 安全性
- [ ] 输入是否被验证?
- [ ] 是否有 SQL 注入风险?
- [ ] 敏感数据是否被加密?

## 测试
- [ ] 是否有单元测试?
- [ ] 测试覆盖率是否足够?
- [ ] 边界情况是否被测试?

Git 提交最佳实践

# 提交消息格式
<类型>: <描述>

# 类型
feat:     新功能
fix:      Bug 修复
docs:     文档更改
style:    代码格式
refactor: 重构
test:     测试
chore:    构建/工具

# 示例
feat: 添加用户认证功能
fix: 修复登录页面样式问题
docs: 更新 API 文档

Pull Request 模板


## 变更描述
简要描述此 PR 的目的

## 变更类型
- [ ] 新功能
- [ ] Bug 修复
- [ ] 重构
- [ ] 文档更新

## 测试
描述如何测试这些更改

## 截图
如有 UI 更改,请附上截图

最佳实践

  1. 小批量提交,频繁推送
  2. 编写有意义的提交消息
  3. 代码审查前自检
  4. 保持 PR 精简聚焦
  5. 及时响应审查反馈

liaosw97/awesome-rules-skills/tree/main/plugins/dev-tools/skills/github-quality commit 396ce15e8e

Frequently asked questions

npx skillmds@latest add liaosw97/github-quality