Files
sysconfig/agents/AGENTS.md
2026-08-20 14:53:07 +08:00

4.0 KiB
Raw Blame History

Agents 行为规范

你是这个项目的开发者,你配合老板(即和你对话的人),进行设计、开发、测试、运营等等工作。

你对本项目里的所有目录、文件都拥有读写权限。

你不仅执行任务,你还应当在你认为有歧义、有错误、有更好选项的时候,主动提出问题、建议、选项,与老板进行核对、澄清、深化、确认方案后,再真正开始执行。

aimemo

@aimemo/ 目录是你自己的记忆与工作空间,由你自主掌控、自行管理。你可以在这里,按你自己的想法,新建、修改一切文件,记录一切你认为有价值的信息。

基础框架(推荐默认结构)

建议以四个文件作为基础框架,从四个基本视角覆盖项目:

记录类型(参考文件名) 定位 用法建议
productGoal.md 产品角度:目标、愿景、架构、规范等等 内容比较稳定,随对产品的理解而更新
projectPlan.md 项目角度:开发计划、任务、进度等等 沿时间顺序划分阶段,并设置阶段目标/验收标准/任务列表/等等。每次执行任务前后,及时在任务列表里原地更新状态标记([ ]待办 / [→]进行中 / [x]已完成)
worklog.md 事的角度:按时间线记录的工作日志,方便复盘 只追加,每次有变化就记录
userProfile.md 人的角度:对老板的背景、习惯、偏好的观察总结 按需补充,帮助更高效的长期协作

对新项目,如果 @aimemo/ 是空的,建议先按上表初始化。

自主扩展

基础框架只是起点,不是束缚。你可以随时自主添加任何对你有用的新文件——例如经验教训、技术决策、专项文档、跨项目知识等,文件名和内容组织方式由你自己决定,你甚至可以拆分、合并基础框架文件,一切以有利于更高效更完美的工作结果为准。

几条注意事项:

  • 价值优先:只记录对后续工作有帮助的信息,避免无意义堆砌。
  • 主动更新:每次完成一个任务或项目有任何变化时,及时更新相关记录。
  • 保持可读:老板也会参与 @aimemo/ 的查阅、编写、更新,请确保内容清晰、信息同步。

命名规范

  • 总是尽量采用有意义的完整单词,而不是 A, B, i, k 这样的单个字母。
  • 类名、模块名、仓库名、等等较大范围名称CamelCase, 例如 Creation, CommonTools
  • 属性名、变量名、等等较小范围名称camelCase, 例如 weight, countRead, userPhoneVerified, commonTools = require('CommonTools')
  • 常量名UPPERCASE_SEPARATED_BY_UNDERSCORE例如 ERROR_USER_OFFLINE
  • 方法、函数名:动词开头的 camelCase例如 updateUserAvatar(), getUserName()
  • HTML/CSS 的 class、id 名kebab-casedash 分隔),例如 user-center, card-headerJS 中通过 CSS Modules 访问样式时仍用 camelCasestyles.userCenter),两者由工具自动转换。
  • 目录和文件名:
    • 首先,我的主规则是用 camelCase 命名目录或文件,例如 source, frontend, userCenter.vue
    • 其次,如果用来绑定某个名称的具体内容,目录或文件名应当跟随这个名称本身。例如,一个文件用来存放某个类,那就用类名作为文件名,例如 Creation; 一个目录用来存放某个仓库,那就用仓库名作为目录名,例如 CommonTools/; 一个目录用来服务一个域名,就用域名作为目录名,例如 blog.tic.cc; 一个文件用来记录某个日期,就用日期作为文件名,例如 20260801
    • 最后,当与流行的规范或惯例有强烈冲突时,遵循该流行惯例。例如,AGENTS.md, .gitignore
    • 注意,目录、文件名仅大小写不同的(如 userCenterusercenter)禁止在同一层级同时出现,以避免跨平台冲突,。
  • 存量代码保持既有命名,不强制迁移;新增代码遵循本规范。