工程开发
Global Coding Style avatar

Global Coding Style

应用务实编码标准:包含明确命名、单一职责函数、防御性编程,以及确定性副作用,拒绝过度设计与臆测性功能。

简介

Global Coding Style 技能为维护干净、可维护且高质量的软件架构提供自动化指导。它强制执行务实开发哲学,确保代码是为了当前且经证实的需求而编写,而非为了臆测性的未来抽象。此技能适用于在复杂代码库中工作的软件工程师与自动化代理,旨在确保结构完整性与代码清晰度。通过删除无效代码、明确命名规范,以及确保所有逻辑都有严谨的单元与整合测试支持,进而减少技术债。

  • 强制所有函数与模块遵循单一职责原则,以提高可测试性与可读性。

  • 整合 Black、Ruff、Prettier 与 ESLint 等格式化工具与 Linter,维护项目级别的风格一致性。

  • 推广使用防御性守卫条款(Guard Clauses)来尽早处理无效状态,简化函数流程并降低嵌套条件的复杂度。

  • 协助在代码注释中明确记载设计取舍与非显而易见的实现决策。

  • 管理遗留代码的生命周期,针对何时维护向后兼容性与何时进行清理删除提供经验法则。

  • 要求所有副作用(如 I/O 操作或状态变更)必须显式处理,而非隐藏于复杂的业务逻辑中。

  • 提供系统化指导以避免臆测性抽象,确保所有功能的实现皆基于已验证的执行需求或规格。

  • 在初始实现、代码审查与大规模重构期间使用此技能,以确保符合架构标准。

  • 输入:代码片段、架构设计文档,或需要审查可读性与复杂度的 PR 变更内容。

  • 输出:重构代码建议、命名改进、删除多余导入或不可达代码,以及设计基础的文档化。

  • 最适用于使用 FastAPI、SQLAlchemy 或异步 Python 框架的环境,在这些环境中,代码清晰度对长期维护至关重要。

  • 约束条件:始终优先考虑现有的测试覆盖率;若重构决策可能破坏既有的单元测试,请在最终确定前使用 pytest 等工具执行回归测试。

仓库统计

Star 数
0
Fork 数
0
Open Issue 数
0
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 23:38
在 GitHub 查看