Ting

Ting

满怀希望就会所向披靡

Codex · AGENTS的入职说明书

AGENTS.md的作用

告诉他你的项目基本信息,不能动什么,数据怎么走,避免重复 交代信息。

AGENT内容

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
# AGENTS.md

## 项目概述
这是一个基于 Next.js 14 + Prisma + PostgreSQL 的 SaaS 应用。
使用 App Router,不使用 Pages Router。

## 技术栈
- 前端:Next.js 14, React 18, TailwindCSS, shadcn/ui
- 后端:Next.js API Routes, Prisma ORM
- 数据库:PostgreSQL 15
- 认证:NextAuth.js

## 重要约定
- 所有数据库操作必须通过 lib/db.ts 中的 prisma 实例
- API 路由错误统一用 lib/api-error.ts 处理
- 环境变量在 .env.local 中,参考 .env.example

## 禁止事项
- 不要修改 prisma/schema.prisma,除非我明确要求
- 不要删除任何现有测试
- 生产环境的 .env 文件不要碰
  • 配置层级
    • 全局层:~/.codex/AGENTS.md
    • 项目层: repo/AGENTS.md
    • 覆写层: repo/services/payments/AGENTS.override.md(子目录)

Codex · 工作流总结

CI/CD:持续集成和持续交付==实现软件发布流程各个阶段(从开发到部署)自动化的方法

PR:Pull Request==拉取请求,开发者可以将自己完成的代码修改提交给代码库的维护者,申请将这些更改合并到目标分支中

CI/CD工作

  • 自动更新CHANGELOG:每次合并主分支后自动根据提交记录更新 CHANGELOG.md(合并到 main 分支后)
  • 生成API文档: 根据代码变更自动生成或同步 API 文档(代码推送后)
  • 自动代码审查:在 PR 流水线里自动跑代码审查并留下注释(PR创建或更新时)

日常开发工作流

步骤

  1. 明确需求: 描述你想要实现的功能
  2. Codex分析:Codex 理解项目结构和规范
  3. 方案讨论: 与 Codex 确认实现方案
  4. 代码生成:Codex 编写代码并修改文件
  5. 验证测试:运行测试确认功能正确
  6. 迭代优化: 根据反馈调整代码

代码理解工作流

步骤

  1. 从入口点开始,让 Codex 解释整体架构
  2. 逐步深入关键模块,理解核心逻辑
  3. 追踪数据流和调用链
  4. 总结关键点和注意事项

快速上手新代码(待总结)

重构工作流

谨慎使用,系统性改进代码结构

0%