From f0ed570bd0fc824361ebee217bc2a14d3c1cdb22 Mon Sep 17 00:00:00 2001 From: yuluo-yx Date: Mon, 27 May 2024 15:57:51 +0800 Subject: [PATCH 1/4] chore: add docs style guide links Signed-off-by: yuluo-yx --- CONTRIBUTING-ZH.md | 1 + CONTRIBUTING.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CONTRIBUTING-ZH.md b/CONTRIBUTING-ZH.md index 183c5e5f..9f5cf385 100644 --- a/CONTRIBUTING-ZH.md +++ b/CONTRIBUTING-ZH.md @@ -20,6 +20,7 @@ | [Helm chart](https://helm.sh/) | The [Kubernetes](https://kubernetes.io/docs/home/) application package | | [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration | | [make](https://www.gnu.org/software/make/) | The automated Build Tools | +| [Docs Guide](https://github.com/LinuxSuRen/api-testing.git) | 文档编写指南 | ## 设置开发环境 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0b31599..dae0ac8d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,7 @@ You might need to know the following tech before get started. | [Helm chart](https://helm.sh/) | The [Kubernetes](https://kubernetes.io/docs/home/) application package | | [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration | | [make](https://www.gnu.org/software/make/) | The automated Build Tools | +| [Docs Guide](https://github.com/LinuxSuRen/api-testing.git) | Documentation Guidelines | ## Setup development environment From 66b737502def1c562092930a639e6d939d5fa7a9 Mon Sep 17 00:00:00 2001 From: yuluo-yx Date: Mon, 27 May 2024 16:00:33 +0800 Subject: [PATCH 2/4] chore: optimzie pr tmpl Signed-off-by: yuluo-yx --- .github/PULL_REQUEST_TEMPLATE.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d20d1676..3db514e7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,11 +2,10 @@ Make sure you run the `make test` command before committing the pr. Making sure that your local build is OK before committing will help you reduce debugging time and make it easier for maintainers to review. - -If you are committing pr for the first time, -please read the contributor's documentation: https://github.com/LinuxSuRen/api-testing/blob/master/CONTRIBUTION.md --> +> If you are committing pr for the first time, please read the contributor's documentation: https://github.com/LinuxSuRen/api-testing/blob/master/CONTRIBUTION.md + **What type of PR is this?** -> If you are committing pr for the first time, please read the contributor's documentation: https://github.com/LinuxSuRen/api-testing/blob/master/CONTRIBUTION.md +> We highly recommend you read the contributor's documentation before starting the review process especially since this is your first contribution to this project. +> +> It was updated on 2024/5/27 **What type of PR is this?** -> We highly recommend you read the contributor's documentation before starting the review process especially since this is your first contribution to this project. +> We highly recommend you read [the contributor's documentation](https://github.com/LinuxSuRen/api-testing/blob/master/CONTRIBUTION.md) before starting the review process especially since this is your first contribution to this project. > > It was updated on 2024/5/27