用途:审查 Contentstack Python CDA SDK 的 PR、提交前自审,或运行自动化审查流程。
主要检查项: API:新增或变更的 Stack、content-type、query、entry 方法需有文档;必要时更新 contentstack/init.py 的导出。 版本:contentstack/init.py 中的 version 需与破坏性变更的发布策略一致。 HTTP:https_connection.py 与 controller.py 的改动需保持重试和超时行为可预测。 测试:pytest tests/ 需通过;CDA 行为变化时扩展 tests/。 密钥:仓库中不得出现 token;config.py 存放真实凭据时仅保留在本地。
公开 API:导出的 Stack、ContentType、Query、asset/entry 辅助方法需与 README 及使用者预期一致;导出变化时 contentstack/init.py 的 all 保持准确;Stack 及关键公开方法在行为或选项变化时更新 docstring。
兼容性:避免在没有 semver 策略的情况下破坏 Stack.init 签名或方法链;破坏性变更需在 setup.py / version 中说明迁移方式。
HTTP 与依赖:对 requests、重试行为或 HTTPSConnection 的改动需与 contentstack/controller.py 及 stack.py 中 urllib3.Retry 的用法保持一致。
安全:源码或文档中不得硬编码 token;不得记录 api_key、delivery_token、preview_token 或 management_token。
严重级别(可选):Blocker 如未经批准破坏公开 API、安全问题、新逻辑无测试;Major 如 HTTP/重试行为不一致、README 示例与代码不符;Minor 如风格、文档小问题。