名称:日常编码 描述:| 日常编码助手,在编写/修改代码时自动触发,提供核心检查清单。
✅ 触发场景:
- 实现新功能、添加代码、修改现有代码
- 用户请求“写一个…”、“实现…”、“添加…”、“修改…”
- 任何涉及编辑/写入工具的编码任务
❌ 不触发:
- 纯阅读/理解代码(无修改意图)
- 已由专业技能覆盖(bug-detective、architecture-design、tdd-guide)
- 配置文件更改、文档编写 版本:1.0.0 标签:[编码,日常,检查清单]
日常编码检查清单
一个最小化的编码质量保证检查清单,确保每次代码修改都遵循最佳实践。
核心检查清单
开始前
- [ ] 阅读后再修改 - 必须在更改前使用读取工具阅读目标文件
- [ ] 理解上下文 - 确认理解现有代码逻辑和设计意图
编码过程中
- [ ] 最小化更改 - 只更改必要的内容,不过度工程化,不添加无关功能
- [ ] 类型安全 - 为Python添加类型提示,避免在TypeScript中使用
any - [ ] 安全检查 - 避免命令注入、XSS、SQL注入漏洞
完成后
- [ ] 验证执行 - 确保代码正确运行,无语法错误
- [ ] 清理 - 移除print/console.log调试语句和临时文件
- [ ] 简要总结 - 告知用户更改了什么以及影响范围
快速参考
常见错误避免
# ❌ 不要
def process(data=[]): # 可变默认参数
pass
# ✅ 应该
def process(data: list | None = None):
data = data or []
# ❌ 不要
except: # 裸异常
pass
# ✅ 应该
except ValueError as e:
logger.error(f"处理失败:{e}")
raise
安全检查点
- 用户输入必须经过验证/转义
- 使用pathlib处理文件路径,避免路径遍历
- 切勿硬编码敏感信息(API密钥、密码)