📦 deps(standards): vendor playbook
This commit is contained in:
@@ -0,0 +1,15 @@
|
||||
# 安全与鉴权(Auth & Security)
|
||||
|
||||
本文件定义代理在涉及鉴权/密钥/权限时必须遵守的最低要求(Python)。
|
||||
|
||||
## 基本原则
|
||||
|
||||
- 默认最小权限:避免使用全局管理员/Root 权限完成可在用户权限完成的事。
|
||||
- 不要提交任何密钥材料:token、私钥、证书、访问密钥、`.env` 中的真实值等。
|
||||
- 任何涉及加密/鉴权的实现变更必须说明威胁模型与兼容性影响。
|
||||
|
||||
## 常见风险与要求
|
||||
|
||||
- 输入校验:对外部输入(CLI 参数、环境变量、文件、网络数据)要做类型/范围校验,避免命令注入、路径穿越等问题。
|
||||
- 依赖安全:避免新增“来源不明”的依赖;如必须新增,需说明来源与版本锁定策略。
|
||||
- 日志脱敏:日志中不得输出凭据、个人敏感信息(PII)或可重放的签名/URL。
|
||||
@@ -0,0 +1,27 @@
|
||||
# 代码质量(Code Quality)
|
||||
|
||||
本文件定义代理对代码质量的最低要求与审查清单(Python)。
|
||||
|
||||
## 1. 总体要求
|
||||
|
||||
- 改动聚焦目标;避免“顺手重构”。
|
||||
- API/行为变更要显式说明影响与迁移方式(尤其是脚本/CLI 输出与配置项)。
|
||||
- 保持仓库现有约定:优先复用既有结构、命名与工具配置(见 `docs/python/`)。
|
||||
|
||||
## 2. 可读性
|
||||
|
||||
- 复杂逻辑拆分为具名函数/模块;避免超长函数。
|
||||
- 尽量使用显式类型与数据结构表达意图(必要时补类型标注)。
|
||||
- 注释解释“为什么”,避免注释重复代码表述。
|
||||
|
||||
## 3. 错误处理
|
||||
|
||||
- 失败必须可观测:返回码/异常/日志至少一种要明确。
|
||||
- CLI/自动化脚本:遇到不可恢复错误应非零退出码。
|
||||
|
||||
## 4. Review 清单
|
||||
|
||||
- 是否引入了不必要的新依赖?
|
||||
- 是否遵循 `pyproject.toml` 与 lint 配置?
|
||||
- 是否对 I/O(文件/网络/数据库)失败路径做了处理?
|
||||
- 是否需要补测试或示例?
|
||||
@@ -0,0 +1,40 @@
|
||||
# Python 代理规则集(.agents/python)
|
||||
|
||||
本规则集用于存放 **AI/自动化代理在仓库内工作时必须遵守的规则**(Python 语言专属)。
|
||||
|
||||
## 范围与优先级
|
||||
|
||||
- 作为仓库级基线规则集使用;更靠近代码目录的规则应更具体并可覆盖基线。
|
||||
- 当代理规则与 `docs` 发生冲突时:
|
||||
1. 安全/合规优先
|
||||
2. 其次保持仓库现有一致性
|
||||
|
||||
## 代理工作原则
|
||||
|
||||
- 先理解目标与上下文,再动手改代码。
|
||||
- 修改要小而清晰;避免无关重构。
|
||||
- 不要引入新依赖或工具,除非明确要求。
|
||||
|
||||
## 子文档
|
||||
|
||||
- 安全与鉴权:`auth.md`
|
||||
- 性能:`performance.md`
|
||||
- 代码质量:`code_quality.md`
|
||||
- 测试:`testing.md`
|
||||
|
||||
## Python 必要约定(必须遵守)
|
||||
|
||||
- 代码风格基线:Google Python Style Guide。
|
||||
- 格式化与静态检查:优先使用仓库既有配置(`pyproject.toml`、`.flake8`、`.pylintrc`、`.pre-commit-config.yaml`);不要在未沟通前切换到另一套工具链。
|
||||
- import 顺序:遵守 `isort profile = google`(若启用)。
|
||||
- 文档字符串:Google 风格(与 `.flake8`/团队约定对齐)。
|
||||
- 命名:遵循 `docs/python/style_guide.md` 中的约定;如与既有代码冲突,以局部一致性优先。
|
||||
|
||||
## 与开发规范的关系
|
||||
|
||||
- 在本仓库内:`docs/python/` 与 `docs/common/`。
|
||||
- 在目标项目内(若按 README 推荐的 subtree prefix `docs/standards/playbook`):
|
||||
- 代码风格:`docs/standards/playbook/docs/python/style_guide.md`
|
||||
- 工具链:`docs/standards/playbook/docs/python/tooling.md`
|
||||
- 配置说明:`docs/standards/playbook/docs/python/configuration.md`
|
||||
- 提交信息:`docs/standards/playbook/docs/common/commit_message.md`
|
||||
@@ -0,0 +1,15 @@
|
||||
# 性能(Performance)
|
||||
|
||||
本文件定义代理在性能相关改动时的最低要求(Python)。
|
||||
|
||||
## 基本原则
|
||||
|
||||
- 先保证正确性与可读性,再做优化。
|
||||
- 优化前先定位瓶颈:避免盲目微优化。
|
||||
- 对可能影响性能的改动,说明复杂度变化与典型数据规模假设。
|
||||
|
||||
## 常见注意点
|
||||
|
||||
- 避免在热路径重复 I/O(文件读写、网络请求、重复解析)。
|
||||
- 对大列表/大文件处理优先采用流式处理与生成器。
|
||||
- 警惕 `O(n^2)` 循环、重复正则编译、重复 JSON/YAML 解析等。
|
||||
@@ -0,0 +1,13 @@
|
||||
# 测试(Testing)
|
||||
|
||||
本文件定义代理在测试相关工作的最低要求(Python)。
|
||||
|
||||
## 原则
|
||||
|
||||
- 优先增加与变更直接相关的测试(回归测试优先)。
|
||||
- 测试应可重复运行、无顺序依赖、尽量避免真实网络/真实环境依赖。
|
||||
|
||||
## 约定(模板)
|
||||
|
||||
- 若项目使用 `pytest`:遵循 `pyproject.toml` 中的 `pytest.ini_options` 配置。
|
||||
- I/O 相关代码建议使用临时目录与 mock,避免污染工作区。
|
||||
Reference in New Issue
Block a user