CONTRIBUTING.md

贡献指南

感谢您考虑为我们的项目做出贡献！以下是一些指导原则，帮助您参与项目开发。

如何贡献

1. Fork 本仓库
2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交您的更改 (git commit -m '添加了一些特性')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启一个 Pull Request

Pull Request 流程

1. 确保您的 PR 描述清楚地说明了所做的更改
2. 确保所有自动化测试通过
3. 更新相关文档
4. 您的 PR 将由维护者审查，可能会要求进行更改

开发指南

代码风格

• 遵循项目既定的代码风格
• 使用有意义的变量和函数名
• 添加必要的注释
• 保持代码简洁

提交信息规范

提交信息应该清晰描述更改内容，建议使用以下格式：

• feat: 新功能
• fix: 修复问题
• docs: 文档修改
• style: 代码格式修改
• refactor: 代码重构
• test: 测试用例修改
• chore: 其他修改

文档

• 如果您添加了新功能，请确保更新相关文档
• 保持文档清晰和最新

问题反馈

• 使用 GitHub Issues 提交问题
• 清晰描述问题和复现步骤
• 如果可能，提供截图或错误日志

行为准则

请阅读并遵守我们的 行为准则。