Skip to content

Commit 775aab1

Browse files
yuluo-yxLinuxSuRen
andauthored
chore: add docs style guide links (#456)
* chore: add docs style guide links Signed-off-by: yuluo-yx <[email protected]> * chore: optimzie pr tmpl Signed-off-by: yuluo-yx <[email protected]> * Update PULL_REQUEST_TEMPLATE.md Signed-off-by: YuLuo <[email protected]> * add the contribution document link Signed-off-by: Rick <[email protected]> --------- Signed-off-by: yuluo-yx <[email protected]> Signed-off-by: YuLuo <[email protected]> Signed-off-by: Rick <[email protected]> Co-authored-by: Rick <[email protected]>
1 parent 00e5345 commit 775aab1

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
Make sure you run the `make test` command before committing the pr.
33
Making sure that your local build is OK before committing will help you reduce debugging time
44
and make it easier for maintainers to review.
5-
6-
If you are committing pr for the first time,
7-
please read the contributor's documentation: https://github.com/LinuxSuRen/api-testing/blob/master/CONTRIBUTION.md
85
-->
96

7+
> 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.
8+
>
9+
> It was updated on 2024/5/27
10+
1011
**What type of PR is this?**
1112
<!--
1213
Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary

Diff for: CONTRIBUTING-ZH.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
| [Helm chart](https://helm.sh/) | The [Kubernetes](https://kubernetes.io/docs/home/) application package |
2121
| [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration |
2222
| [make](https://www.gnu.org/software/make/) | The automated Build Tools |
23+
| [Docs Guide](https://github.com/LinuxSuRen/api-testing.git) | 文档编写指南 |
2324

2425
## 设置开发环境
2526

Diff for: CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ You might need to know the following tech before get started.
2020
| [Helm chart](https://helm.sh/) | The [Kubernetes](https://kubernetes.io/docs/home/) application package |
2121
| [GitHub Actions](https://docs.github.com/en/actions) | The continuous integration |
2222
| [make](https://www.gnu.org/software/make/) | The automated Build Tools |
23+
| [Docs Guide](https://github.com/LinuxSuRen/api-testing.git) | Documentation Guidelines |
2324

2425
## Setup development environment
2526

0 commit comments

Comments
 (0)