Skip to content

Latest commit

 

History

History
146 lines (93 loc) · 7.56 KB

contributing.md

File metadata and controls

146 lines (93 loc) · 7.56 KB

How to contribute 👏

If you are interested in this project, you are welcome to incubate this project together, you can start from any of the following directions

  • There are typos or unclear expressions in the documentation or comments
  • There are security risks in the code or dependencies, or lack of checksum and other abnormal judgments
  • Enhancement of response-handler function
  • Problems or pain points encountered in the actual use
  • etc...

You can submit an Issue or a Pull Request (PR) 1 for the above issue. If you're not sure how to submit a PR, here's how to do it

  1. Click Fork in the upper-right corner. This step will create a repository with the same name in your GitHub repository list.
  2. Make changes to the code in this same repository
  3. GitHub will automatically display a PR (Pull Request) prompt

Enhancement of response-handler function

If you have new requirements, you can develop response-handler twice, or create new submodules in the response-handler-plus directory after Fork, see response-handler-custom-status-plugin, and submit a PR to Response-Handler once you have successfully modified and debugged the code locally.

However, I would recommend that you create a new project of your own and import the response-handler-core module in the new project. Finally, submit an issue to the Response-Handler.

Note: If you need to import response-handler dependencies in your new submodule, please do not use response-handler-start module, but use response-handler-core.

<dependency>
    <groupId>io.github.unickcheng</groupId>
    <artifactId>response-handler-core</artifactId>
    <version>${project.version}</version>
</dependency>

How to develop and debug code locally

The current project has two separate modules, one is response-handler and the other is spring-boot-demo. The former is responsible for implementing the current project's dependencies, while the latter is used to provide reference samples and test dependencies.

Step 1: Verify the local environment

You need to download  jdk 1.8  and maven 3.x and configure them in the environment variables. If you are using IDEA, you can also configure it directly in IDEA

Step 2: Clone the project and install all maven dependencies

git clone https://github.com/UNICKCHENG/Response-Handler.git
# Install the dependencies for response-handler
mvn install -f Response-Handler/pom.xml
# Install the dependencies for demo
mvn install -f Response-Handler/spring-boot-demo/pom.xml

Step 3: Start developing and verifying the code

You can run spring boot for spring-boot-demo. Once you have modified the code in the response-handler-* directory, restart spring boot and it will automatically build the response-handler project.

If you prefer to operate from the command line, you can execute the following command in the Response-Handler root directory after you have modified the code

# run spring boot
mvn spring-boot:run -f spring-boot-demo/pom.xml

Finally, when the mvn clean test -f spring-boot-demo/pom.xml command is executed without errors, feel free to submit a PR to Response-Handler after git push to your repository of the same name.

Note that the mvn clean test error means there is a problem in your code, please check it carefully and do not use -Dmaven.test.skip=true to skip the test

如果你更倾向于中文

参与贡献 👏

如果您对这个项目感兴趣，欢迎一起来孵化这个项目，您可以从下面任何方向开始

  • 文档或注释中存在错别字、表述不清晰等情况
  • 代码或依赖存在安全隐患，或缺少校验等异常判断
  • 增强 response-handler 周边
  • 在实际使用中，碰到的问题或痛点
  • 等等...

针对上面的问题您可以提个 Issue，或者提个 PR（Pull Request）1 。如果您不清楚如何提 PR，可以参考下面步骤

  1. 点击右上角 Fork，这个步骤将会在您的 GitHub 仓库列表中创建同名仓库
  2. 对这个同名仓库中的代码进行修改
  3. 此时，GitHub 会自动出现 PR（Pull Request）提示

增强 response-handler 周边

您可以基于新的需求针对 response-handler 二次开发，或者 Fork 后，在 response-handler-plus 目录下创建新的子模块，可参考 response-handler-customstatus。在本地修改和调试代码成功后，向 Response-Handler 提个 PR 即可。

不过我更推荐您，新建一个自己的项目，然后在新项目中导入 response-handler-core 模块，最后再向 Response-Handler 提个 Issues。

注意：如果在您新建的子模块中需要引入 response-handler 依赖，请不要引入 response-handler-starter 模块，而是使用 response-handler-core 依赖。

<dependency>
    <groupId>io.github.unickcheng</groupId>
    <artifactId>response-handler-core</artifactId>
    <version>${project.version}</version>
</dependency>

如何在本地开发和调试代码

当前项目有两个独立的模块，一个是 response-handler，另一个是 spring-boot-demo。前者负责实现当前项目的依赖，而后者用于提供参考样例和测试依赖。

步骤1：请确保成功配置环境

您需要下载 jdk 1.8 和 maven 3.x，并且在环境变量中进行配置。如果您使用 IDEA，也可以直接在 IDEA 中进行配置

步骤2：克隆项目和安装所有 maven 依赖

git clone https://github.com/UNICKCHENG/Response-Handler.git
# 安装 response-handler 所有依赖
mvn install -f Response-Handler/pom.xml
# 安装 demo 中的依赖
mvn install -f Response-Handler/spring-boot-demo/pom.xml

步骤3：开始开发和验证代码

您可以为 spring-boot-demo 启动 spring boot，一旦您修改了 response-handler-* 目录下的代码，请重启 spring boot，它将会自动构建 response-handler 项目。

如果您喜欢通过命令行操作，请您修改完代码后，可以在 Response-Handler 根目录执行下述命令

# 运行 spring boot 
mvn spring-boot:run -f spring-boot-demo/pom.xml

最后，如果执行 mvn clean test -f spring-boot-demo/pom.xml 没有任何错误，在 git 提交到您的同名仓库后，欢迎顺手提个 PR 到 Response-Handler。

注意，mvn clean test 报错说明您的代码中存在问题，请仔细排查，不要使用 -Dmaven.test.skip=true 来跳过测试

Footnotes

  1. https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request ↩ ↩2