article
README
🚀 代码审查知识库
本目录包含pgEdge Postgres MCP服务器项目的代码质量指南和模式。该知识库为项目提供了代码质量标准、需避免的常见反模式、按变更类型划分的审查清单以及特定于项目的模式,有助于提升代码质量和审查效率。
🚀 快速开始
本知识库涵盖了代码质量标准、常见问题、审查清单等内容,为pgEdge Postgres MCP服务器项目的代码审查提供全面指导。你可以根据需要查看相应文档,确保代码符合项目要求。
✨ 主要特性
- 提供代码质量标准:明确项目的命名规范、错误处理模式、代码组织方式和复杂度准则。
- 指出常见反模式:列举Go、React等语言的反模式,以及数据库查询和错误处理方面的问题。
- 提供审查清单:针对新功能、错误修复、重构和性能变更等不同类型的变更,提供相应的审查清单。
- 特定于项目的模式:包含项目特定的代码模式和规范。
📚 详细文档
质量标准
项目的代码质量标准,包括:
- 命名规范
- 错误处理模式
- 代码组织
- 复杂度准则
常见问题
代码审查过程中经常发现的问题,包括:
- Go语言反模式
- React反模式
- 数据库查询问题
- 错误处理问题
审查清单
不同类型变更的审查清单,包括:
- 新功能审查清单
- 错误修复审查清单
- 重构审查清单
- 性能变更审查清单
📦 快速参考
相关知识库
如需特定语言的指导,请参考:
- Go模式:
/.claude/golang-expert/ - React模式:
/.claude/react-expert/ - 测试模式:
/.claude/testing-expert/ - 安全审查:
/.claude/security-auditor/
关键质量指标
| 指标 | 目标 | | ---- | ---- | | 函数长度 | < 50 行 | | 圈复杂度 | < 10 | | 嵌套深度 | < 4 层 | | 测试覆盖率 | > 80% |
项目约定
- 所有语言均使用四个空格缩进。
- 不提交未使用的代码。
- 对所有导出内容进行文档说明。
- 为所有新功能编写测试。
📄 文档更新
在以下情况下更新这些文档:
- 建立新的模式。
- 识别出常见问题。
- 审查标准发生变化。
- 发现新的反模式。
最后更新时间:2026-01-09
微信扫一扫