贡献指南

欢迎贡献代码

---

📋 贡献流程

1. Fork 仓库

在 GitHub 上 Fork 仓库：

https://github.com/Agions/taskflow-ai

2. 克隆仓库

git clone https://github.com/your-username/taskflow-ai.git
cd taskflow-ai

3. 创建分支

git checkout -b feature/your-feature

4. 开发

# 安装依赖
npm install

# 启动开发模式
npm run dev

# 运行测试
npm test

5. 提交

git add .
git commit -m "feat: add your feature"

6. 推送

git push origin feature/your-feature

7. 创建 Pull Request

在 GitHub 上创建 Pull Request。

---

📝 代码规范

TypeScript

// ✅ 好的风格
interface User {
  id: number;
  name: string;
}

// ❌ 避免的风格
interface User {
  id: any;
  name: any;
}

命名约定

类型	约定	示例
变量/函数	camelCase	getUserById
类/接口	PascalCase	UserService
常量	UPPER_SNAKE_CASE	MAX_RETRY
私有成员	_camelCase	_internalCache

提交信息

<type>(<scope>): <description>

[optional body]

[optional footer]

类型：

类型	说明
feat	新功能
fix	Bug 修复
docs	文档更新
style	代码格式
refactor	代码重构
test	测试相关
chore	构建/工具

示例：

feat(mcp): add filesystem tool

- Add listDirectory tool
- Add readFile tool
- Add writeFile tool

Closes #123

---

🧪 测试要求

单元测试

npm test

覆盖率要求

模块	最低覆盖率
核心模块	90%
MCP 工具	85%
CLI	80%

运行测试

# 运行所有测试
npm test

# 运行特定测试
npm test -- filesystem

# 查看覆盖率
npm run test:coverage

---

📖 文档要求

新增功能

• 添加 API 文档
• 添加使用示例
• 更新导航

修改功能

• 更新相关文档
• 添加变更说明

---

🔍 代码审查

审查清单

• [ ] 代码符合规范
• [ ] 测试通过
• [ ] 文档已更新
• [ ] 无安全漏洞
• [ ] 性能无回归

审查流程

1. 自动 CI 检查
2. 维护者审查
3. 合并到主分支

---

💬 交流渠道

渠道	说明
💬 GitHub Discussions	问题讨论
🐛 GitHub Issues	提交 Bug
📧 Email	联系维护者

---

📄 行为准则

• 尊重他人
• 建设性反馈
• 接受批评
• 帮助新人

---

🔗 相关链接

• 代码规范
• 测试指南
• 架构说明

---

贡献代码有问题随时问我