test_framework
/
api-testing
mirror of https://github.com/LinuxSuRen/api-testing.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: add docs style guide links (#456) 

* chore: add docs style guide links

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

* chore: optimzie pr tmpl

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

* Update PULL_REQUEST_TEMPLATE.md

Signed-off-by: YuLuo <yuluo08290126@gmail.com>

* add the contribution document link

Signed-off-by: Rick <1450685+LinuxSuRen@users.noreply.github.com>

---------

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
Signed-off-by: YuLuo <yuluo08290126@gmail.com>
Signed-off-by: Rick <1450685+LinuxSuRen@users.noreply.github.com>
Co-authored-by: Rick <1450685+LinuxSuRen@users.noreply.github.com>
This commit is contained in:
YuLuo 2024-05-27 17:24:32 +08:00 committed by GitHub
parent 00e53452fc
commit 775aab1d30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -2,11 +2,12 @@
Make sure you run the `make test` command before committing the pr. 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 Making sure that your local build is OK before committing will help you reduce debugging time
and make it easier for maintainers to review. 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
--> -->
> 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
**What type of PR is this?** **What type of PR is this?**
<!-- <!--
Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary

1
CONTRIBUTING-ZH.md
View File

@ -20,6 +20,7 @@
| [Helm chart](https://helm.sh/) | The [Kubernetes](https://kubernetes.io/docs/home/) application package | | [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 | | [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration |
| [make](https://www.gnu.org/software/make/) | The automated Build Tools | | [make](https://www.gnu.org/software/make/) | The automated Build Tools |
| [Docs Guide](https://github.com/LinuxSuRen/api-testing.git) | 文档编写指南 |
## 设置开发环境 ## 设置开发环境

1
CONTRIBUTING.md
View File

@ -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 | | [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 | | [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration |
| [make](https://www.gnu.org/software/make/) | The automated Build Tools | | [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 ## Setup development environment