Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (55 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 1.85 KB

贡献指南 (Contributing Guidelines)

感谢您对 Easy HTTP 项目的兴趣！本文档提供了参与项目贡献的详细说明。

开发环境设置

  1. 克隆项目：

    git clone https://github.com/mr-box/easy-http.git
cd easy-http

  2. 确保安装了 Java 8+ 和 Maven 3.6+

  3. 构建项目：

    mvn clean install

如何贡献

报告 Bug

当您发现 Bug 时，请通过 Issues 页面提交报告，并包含以下信息：

  • 详细的 Bug 描述
  • 复现步骤
  • 预期行为与实际行为的对比
  • 您的环境信息（操作系统、Java 版本等）

提交功能请求

对于新功能请求，请创建 Issue 并描述：

  • 您想要的功能
  • 为什么需要这个功能
  • 您希望如何实现它

代码贡献

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

代码风格

  • 遵循现有的代码格式和命名约定
  • 为新的功能和复杂逻辑编写单元测试
  • 确保所有测试都能通过
  • 为公共 API 方法添加适当的注释

项目结构

easyhttp
├── client      # 各种HTTP客户端的具体实现
│   ├── apache  # 基于Apache HttpClient的实现
│   ├── jetty   # 基于Jetty HttpClient的实现（待实现）
│   └── okhttp  # 基于OkHttp的实现（待实现）
├── config      # 配置相关的类
├── core        # 核心接口和抽象
└── exception   # 自定义异常类

测试

在提交代码之前，请确保所有测试都能通过：

mvn test

如果添加了新功能，请同时添加相应的单元测试和属性测试。

问题和讨论

如果您有任何疑问，请随时创建 Issue 进行讨论。