Files
JobRadar/docs/development-guide.md

57 lines
2.3 KiB
Markdown

# JobRadar AI开发约定
## 开发模式
JobRadar不再采用课程式手动编码。后续由AI根据阶段目标直接生成和修改代码,用户主要负责业务方向、关键选择和结果验收。
## 每次开发流程
1. 检查Git状态、现有实现、依赖和相关文档。
2. 说明修改方案、涉及文件、风险和预期结果。
3. 在授权范围内直接完成代码、配置、数据库迁移、测试和文档改动。
4. 执行与改动匹配的验证,不以静态检查替代未执行的集成行为。
5. 汇报实际完成内容、验证结果、剩余风险和建议下一步。
6. 只有用户明确要求提交时才执行本地Git提交,默认不推送远程。
## 生成原则
- 以当前阶段的最小完整闭环为边界,不提前生成无法验证的未来模块。
- 优先使用OpenAI Agents SDK、Django等选定技术的原生能力,不引入无明确需求的兼容层。
- 所有Agent外部行为通过类型明确、权限受控、可审计的工具执行。
- 确定性规则、评分和数据写入由代码工具完成,不让模型随意生成最终业务事实。
- 新增代码遵循现有目录、命名、类型注解和中文注释风格。
- 保留用户已有变更,不覆盖无关文件,不提交密钥、Cookie和本地配置。
## 验证要求
根据改动范围选择并执行:
- Python语法编译和代码质量检查。
- Django系统检查与迁移检查。
- 模型、Service、工具和视图测试。
- Agent结构化输出、工具调用、失败路径和人工确认测试。
- 公网部署配置与Django部署安全检查。
- Git差异、敏感信息和提交范围检查。
无法运行的验证必须明确说明原因,不能仅凭代码阅读宣称通过。
## 交付要求
每次交付至少说明:
- 完成了什么功能。
- 修改了哪些核心文件。
- 执行了哪些验证及其结果。
- 是否存在需要用户提供的域名、账号、API Key或网站授权。
- 当前工作区是否已提交、是否推送。
## 用户确认边界
以下事项仍需用户明确决定:
- 目标招聘网站和允许的访问方式。
- 外部付费服务、模型及调用预算。
- 公网域名、服务器和部署平台。
- 可能产生费用或对外副作用的操作。
- 自动投递、自动联系、删除历史数据等高风险能力。