Loading...
Loading...
Compare original and translation side by side
git clone https://github.com/user/package && cd package
cat pyproject.toml | head -50 # Modern config?
ls tests/ && pytest --collect-only # Tests exist?
pytest --cov=package | tail -20 # Coverage?
pip install bandit && bandit -r src/ # Security?git clone https://github.com/user/package && cd package
cat pyproject.toml | head -50 # 是否采用现代化配置？
ls tests/ && pytest --collect-only # 是否存在测试用例？
pytest --cov=package | tail -20 # 测试覆盖率如何？
pip install bandit && bandit -r src/ # 安全性如何？| Area | Check For |
|---|---|
| Structure | src/ layout, py.typed marker |
| Packaging | pyproject.toml (not setup.py) |
| Code | Type hints, docstrings, no anti-patterns |
| Tests | 80%+ coverage, edge cases |
| Security | No secrets, input validation, pip-audit clean |
| Docs | README, API docs, changelog |
| API | Consistent naming, sensible defaults |
| CI/CD | Tests on PR, multi-Python, security scans |
| 领域 | 检查要点 |
|---|---|
| 项目结构 | src/目录结构、py.typed标记 |
| 打包配置 | 使用pyproject.toml（而非setup.py） |
| 代码质量 | 类型提示、文档字符串、无反模式 |
| 测试情况 | 覆盖率80%以上、覆盖边缘案例 |
| 安全防护 | 无硬编码密钥、输入验证、pip-audit检测通过 |
| 文档完善度 | README文档、API文档、变更日志 |
| API设计 | 命名一致、默认配置合理 |
| CI/CD流程 | 拉取请求时自动运行测试、多Python版本兼容、安全扫描 |
undefinedundefined| Category | Score |
|---|---|
| Structure | ⭐⭐⭐⭐⭐ |
| Testing | ⭐⭐⭐☆☆ |
| Security | ⭐⭐⭐⭐☆ |
| 领域 | 评分 |
|---|---|
| 项目结构 | ⭐⭐⭐⭐⭐ |
| 测试情况 | ⭐⭐⭐☆☆ |
| 安全防护 | ⭐⭐⭐⭐☆ |
For detailed checklists, see:
- **[CHECKLIST.md](CHECKLIST.md)** - Full review checklist
- **[REPORT_TEMPLATE.md](REPORT_TEMPLATE.md)** - Complete report template
更多详情请查看：
- **[CHECKLIST.md](CHECKLIST.md)** - 完整审查清单
- **[REPORT_TEMPLATE.md](REPORT_TEMPLATE.md)** - 完整报告模板Essential:
- [ ] pyproject.toml valid
- [ ] Tests exist and pass
- [ ] README has install/usage
- [ ] LICENSE present
- [ ] No hardcoded secrets
Important:
- [ ] Type hints on public API
- [ ] CI runs tests on PRs
- [ ] Coverage > 70%
- [ ] Changelog maintained
Recommended:
- [ ] src/ layout
- [ ] py.typed marker
- [ ] Security scanning in CI
- [ ] Contributing guide基础要求：
- [ ] pyproject.toml配置有效
- [ ] 存在测试用例且全部通过
- [ ] README包含安装/使用说明
- [ ] 存在LICENSE文件
- [ ] 无硬编码密钥
重要要求：
- [ ] 公共API带有类型提示
- [ ] CI在拉取请求时自动运行测试
- [ ] 测试覆盖率>70%
- [ ] 维护变更日志
推荐要求：
- [ ] 采用src/目录结构
- [ ] 带有py.typed标记
- [ ] CI中包含安全扫描
- [ ] 贡献指南