Skip to content

Latest commit

 

History

History
123 lines (83 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

123 lines (83 loc) · 2.09 KB

Contributing to HumanAPI

感谢你对 HumanAPI 的贡献！我们欢迎任何形式的帮助。

🤝 如何贡献

1. Fork 项目

点击 GitHub 仓库右上角的 "Fork" 按钮

2. 创建分支

git checkout -b feature/your-feature-name

3. 提交更改

git commit -m "Add some feature"

4. 推送到分支

git push origin feature/your-feature-name

5. 创建 Pull Request

在 GitHub 上创建 Pull Request

📝 开发规范

代码风格

  • 使用 TypeScript
  • 遵循 ESLint 规则
  • 使用 Prettier 格式化
  • 添加必要的注释

提交信息

使用清晰的提交信息：

feat: add user authentication
fix: resolve booking status bug
docs: update README
style: format code
refactor: simplify API logic
test: add unit tests
chore: update dependencies

分支命名

  • feature/ - 新功能
  • fix/ - 修复 bug
  • docs/ - 文档更新
  • refactor/ - 重构
  • test/ - 测试相关
  • chore/ - 其他任务

🐛 报告 Bug

提交 Bug 时请包含：

  1. 描述 - 清晰描述问题
  2. 重现步骤 - 如何重现问题
  3. 预期行为 - 应该发生什么
  4. 实际行为 - 实际发生了什么
  5. 环境信息 - 操作系统、Node.js 版本等
  6. 截图/日志 - 如果适用

💡 功能建议

提交功能建议时请包含：

  1. 功能描述 - 详细描述建议的功能
  2. 使用场景 - 在什么场景下使用
  3. 优先级 - 低/中/高
  4. 可能的实现方式（可选）

📚 文档改进

欢迎改进文档：

  • 修正错误
  • 添加示例
  • 改进说明
  • 翻译文档

🔍 代码审查

所有 Pull Request 都需要经过代码审查。

审查要点

  • 代码质量
  • 测试覆盖
  • 文档更新
  • 性能影响
  • 安全性

⚠️ 注意事项

  • 确保你的代码通过所有测试
  • 不要提交敏感信息（API keys 等）
  • 保持提交历史清晰
  • 及时响应审查意见

📧 联系我们

如有疑问，请：

再次感谢你的贡献！🎉