diff --git a/CONTRIBUTING_zh-CN.md b/CONTRIBUTING_zh-CN.md new file mode 100644 index 0000000..7cd5008 --- /dev/null +++ b/CONTRIBUTING_zh-CN.md @@ -0,0 +1,154 @@ + +# 贡献指南:为 The Agency 做出贡献 + +首先,感谢你考虑为 The Agency 做出贡献!正是因为有像你这样的人,才让这套 AI 智能体(Agents)集变得更好。 + +📋 **目录** + +* [行为准则](https://www.google.com/search?q=%23%E8%A1%8C%E4%B8%BA%E5%87%86%E5%88%99) +* [我能如何贡献?](https://www.google.com/search?q=%23%E6%88%91%E8%83%BD%E5%A6%82%E4%BD%95%E8%B4%A1%E7%8C%AE) +* [智能体设计规范](https://www.google.com/search?q=%23%E6%99%BA%E8%83%BD%E4%BD%93%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83) +* [Pull Request (PR) 流程](https://www.google.com/search?q=%23pull-request-%E6%B5%81%E7%A8%8B) +* [风格指南](https://www.google.com/search?q=%23%E9%A3%8E%E6%A0%BC%E6%8C%87%E5%8D%97) +* [社区](https://www.google.com/search?q=%23%E7%A4%BE%E5%8C%BA) + +--- + +## 📜 行为准则 + +本项目及所有参与者均受我们的行为准则约束。参与时,请遵守以下准则: + +* **保持尊重**:尊重每一个人。鼓励健康的辩论,但绝不容忍人身攻击。 +* **包容性**:欢迎并支持各种背景和身份的人。 +* **协作精神**:我们共同创造的东西比独自创造的更好。 +* **保持专业**:让讨论聚焦于提升智能体和社区。 + +--- + +## 🎯 我能如何贡献? + +### 1. 创建新智能体 (Create a New Agent) + +有特定领域智能体的创意吗?太棒了!添加方法如下: + +1. **Fork 本仓库**。 +2. **选择合适的类别**(或提议新类别): +* `engineering/` - 软件开发专家 +* `design/` - UI/UI 及创意专家 +* `marketing/` - 增长与营销专家 +* `product/` - 产品管理专家 +* `project-management/` - 项目管理与协调专家 +* `testing/` - QA 与测试专家 +* `support/` - 运营与支持专家 +* `spatial-computing/` - AR/VR/XR 专家 +* `specialized/` - 无法归类到其他地方的独特专家 + + +3. **按照下方模板**创建你的智能体文件。 +4. **在真实场景中测试**你的智能体。 +5. **提交 Pull Request (PR)**。 + +### 2. 改进现有智能体 + +* 添加真实世界的示例和用例。 +* 使用现代模式优化代码示例。 +* 根据新的最佳实践更新工作流。 +* 添加成功指标(Success Metrics)和基准。 +* 修复错别字、提升清晰度、完善文档。 + +### 3. 分享成功故事 + +在 GitHub Discussions 中发布心得,或在 README 中添加案例研究。 + +### 4. 报告问题 (Issue) + +发现问题了吗?请告诉我们:提供清晰的复现步骤,并附带你的使用背景。 + +--- + +## 🎨 智能体设计规范 + +每个智能体文件都应遵循以下结构: + +```markdown +--- +name: 智能体名称 +description: 一句话描述该智能体的专长和重点 +color: 颜色名称或 "#十六进制代码" +--- + +# 智能体名称 + +## 🧠 身份与记忆 +- **角色 (Role)**: 清晰的角色描述。 +- **性格 (Personality)**: 性格特征与沟通风格。 +- **记忆 (Memory)**: 智能体需要记住和学习的内容。 +- **经验 (Experience)**: 领域专业知识与视角。 + +## 🎯 核心使命 +- 具有明确产出物的核心职责 1、2、3。 +- **默认要求**: 始终开启的最佳实践。 + +## 🚨 必须遵守的硬性规则 +定义智能体方法的领域特定规则和约束。 + +## 📋 技术产出物 (Technical Deliverables) +智能体产出的具体示例:代码示例、模板、框架、文档。 + +## 🔄 工作流流程 (Workflow Process) +1. 第一阶段:探索与研究 +2. 第二阶段:规划与策略 +3. 第三阶段:执行与实现 +4. 第四阶段:复盘与优化 + +## 💭 沟通风格 +语气、常用短语模式等。 + +## 🎯 成功指标 (Success Metrics) +* 量化指标(带数字) +* 定性指标 +* 性能基准 + +``` + +--- + +## 🔄 Pull Request (PR) 流程 + +### 提交前 + +* **测试你的智能体**:在真实场景中使用,并根据反馈进行迭代。 +* **遵循模板**:与现有智能体的结构保持一致。 +* **添加示例**:包含至少 2-3 个代码/模板示例。 +* **校对**:检查错别字、格式问题和清晰度。 + +### 提交 PR 步骤 + +1. **Fork** 仓库。 +2. **创建分支**:`git checkout -b add-agent-name`。 +3. **提交更改**:`git commit -m "Add [Agent Name] specialist"`。 +4. **推送**:`git push origin add-agent-name`。 +5. **开启 PR**:标题清晰(如 "Add [Name] - [Category]"),并描述其用途和测试情况。 + +--- + +## 📐 风格指南 + +* **具体化**:写“减少 60% 加载时间”,而不是“加快速度”。 +* **务实**:包含真实可用的代码,而不是伪代码。 +* **格式化**:始终使用 Markdown;章节标题加入 Emoji 方便扫描;代码示例使用代码块。 + +--- + +## 🌟 荣誉榜 + +做出重大贡献的参与者将: + +* 列入 README 的致谢名单。 +* 在发布说明(Release Notes)中被重点介绍。 +* 有机会在“本周智能体”中展示。 + +--- + +🎉 **谢谢你!** +无论你是添加新智能体、修复 Bug 还是分享故事,你都在让 The Agency 变得更好。谢谢! diff --git a/在你的仓库里,新建一个文件叫 CONTRIBUTING_zh-CN.md b/在你的仓库里,新建一个文件叫 CONTRIBUTING_zh-CN.md deleted file mode 100644 index 8b13789..0000000 --- a/在你的仓库里,新建一个文件叫 CONTRIBUTING_zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -