Skip to content

LIXianSenQwQ/readable-flow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Readable Flow

Readable Flow 是一个面向 Java Spring 和后端项目的 Skill,用来约束 AI 生成更容易被人阅读和维护的代码。

它不反对封装,而是反对过度封装:不要为了“看起来工程化”,把一个本来可以顺序阅读的业务流程拆散到许多零散小方法、Helper、Manager、Processor、接口或抽象层里。

适用场景

  • 希望 Java Spring 代码能从主 service 方法顺着读懂。
  • AI 容易把简单业务逻辑拆成过多小方法。
  • 允许一个较长方法,但要求它有清晰的步骤结构。
  • 希望每一次方法提取或抽象都能说明它如何提升可读性。

核心规则

优先保留一个清晰、线性的主流程。只有当提取方法或引入抽象能让业务流程更容易理解时,才允许这么做。

文件说明

  • SKILL.md:默认 skill 指令。
  • agents/openai.yaml:Codex 使用的界面元数据。

About

AI 经常为了让代码看起来更工程化,把一个本来可以顺序阅读的业务流程拆成接口、抽象类、抽象方法、模板方法、工厂、策略、通用父类、helper、manager、processor 或许多零散小方法。结果是读者必须在多个文件和方法之间跳转,才能拼出真实业务流程。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors