Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.41 KB

贡献指南

感谢您对 Pi Java 项目的贡献!

如何贡献

  1. Fork 项目
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

代码规范

  • 遵循Java编码规范
  • 添加适当的JavaDoc注释
  • 确保所有测试通过
  • 更新相关文档

测试要求

  • 所有新功能必须包含单元测试
  • 修改现有功能时,确保相关测试仍然通过
  • 使用mvn test运行测试套件

文档更新

  • 更新README.md中的相关部分
  • 添加新功能的使用示例
  • 更新API文档(如果适用)

问题报告

如果您发现了bug或有功能建议,请在GitHub Issues中提交。

提交Bug报告

请包含以下信息:

  • 问题的详细描述
  • 重现步骤
  • 您的环境信息(操作系统、Java版本、Maven版本)
  • 相关的错误日志

提交功能请求

请包含以下信息:

  • 功能的详细描述
  • 使用场景
  • 可能的实现方案(如果有的话)

开发环境设置

  1. 安装Java 17+
  2. 安装Maven 3.8+
  3. 克隆项目:git clone <your-pi-java-repository-url>
  4. 编译项目:mvn clean compile
  5. 运行测试:mvn test

联系方式

  • 项目讨论:GitHub Discussions
  • 问题反馈:GitHub Issues
  • 代码审查:Pull Requests

再次感谢您的贡献! 🎉