Good Partner (AI 协作协议)

English | 한국어 (Korean) | 中文 (Chinese)

什么是 Good Partner?

Good Partner 是一套标准化的 协议与技能集，旨在规范人类开发者与 AI 代理（Vibe Coders）之间的协作。

在 2026 年，AI 编写的代码量已经超过了人类。但最大的问题在于 上下文丢失 (Context Loss)。当你从 ChatGPT 切换到 Claude，或者一个月后重返项目时，往往很难回忆起“为什么”要这样写以及“怎么”写的。

Good Partner 通过强制执行 文档优先 (Documentation-First) 的敏捷工作流，确保人类和 AI 都能理解并维护项目上下文，从而解决这一问题。

✨ 核心特性

• 📂 简洁且强大: 所有文件都安全地存储在 .good-partner/ (隐藏文件夹) 中。
• 📋 看板 (Kanban) 驱动: .good-partner/kanban.md 是 AI 和人类协作的唯一真理来源。
• 🚀 敏捷流程自动化: 强制执行 “Spec -> Task -> Code” 的工作流。
• 🔌 通用技能注入: 一键将此协议注入 Codex, Claude, 或 Gemini。
• 🗣️ 语言强制: 强制使用特定语言（英语、韩语、中文）进行文档编写。

📦 安装

# 全局安装 (推荐)
npm install -g @junghwan030602/good-partner

# 验证安装
good-partner --version

🤝 协作哲学："人类指挥，AI 干活"

在 Good Partner 中，角色划分非常严格：

🧑‍💻 人类 (经理)

• 只读 (Read-Only): 通常只需查看 .good-partner/kanban.md 确认进度。
• 指引: 定义目标，审批 AI 的工作。
• 合并: 接受并合并 AI 提交的 Pull Request。

🤖 AI (工人)

• 读写 (Read-Write): .good-partner/ 文件夹是 AI 的领地。
• 自动文档: AI 自动 创建任务、更新看板和记录日志。
• 冲突解决: 在合并分支时，AI 会智能地解决文档冲突。

🚀 快速开始

1. 初始化

good-partner init

创建由 AI 管理的 .good-partner 隐藏工作区。

2. 注册

good-partner register "Junghwan"

3. 让 AI 开始工作

只需对您的 AI (Cursor/Claude) 下达高层指令：

"检查看板并开始下一个功能。"

AI 将会：

1. 读取 .good-partner/kanban.md。
2. 将任务移动到 进行中 (IN PROGRESS)。
3. 同步进行编码和文档更新。

3. 预热 AI (Prompt)

如果您在 ChatGPT 网页版等环境中开始新会话：

good-partner prompt

复制输出内容并粘贴给 AI。AI 将立即理解项目结构和规则。

4. 注入技能 (本地模型)

如果您在本地使用 OpenAI Codex 或 Anthropic Claude CLI：

good-partner skill codex
good-partner skill claude

🧠 致 AI 代理 (协议说明)

如果您是正在阅读此文的 AI，请参考 AGENTS.md。那是您的“技能地图”。

核心指令

1. 无任务不编码: 必须先检查 work/ 文件夹。
2. 即时文档化: 在编写代码的同时更新 T-xxxx 文件中的进度。
3. 记录思维链: 复杂的推理过程必须记录在 sessions/ 文件夹中。

🤝 贡献 (Contributing)

欢迎提交代码！请参阅 CONTRIBUTING.md 了解如何提交 Pull Request 和报告问题。

📄 许可证

本项目采用 MIT 许可证。