Skip to content

Commit 1e49257

Browse files
authored
chore: simplify PULL_REQUEST_TEMPLATE (#1327)
1 parent 148a302 commit 1e49257

File tree

1 file changed

+37
-30
lines changed

1 file changed

+37
-30
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+37-30
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,37 @@
11
<!-- Thanks for sending a pull request! -->
2-
<!-- Have I run `make ci`? -->
3-
4-
**What this PR does / why we need it**:
5-
6-
This PR
72

8-
**Which issue(s) this PR fixes**:
9-
<!--
10-
*Automatically closes linked issue when PR is merged.
11-
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
12-
-->
13-
Fixes #
3+
## What this PR does / why we need it?
144

15-
**Which docs this PR relation**:
5+
This PR ...
166

17-
Ref #
18-
19-
**Which toolchain this PR adaption**:
7+
### What is the impact of this PR?
208

219
No Breaking Change
2210

11+
<!--
2312
**Special notes for your reviewer**:
24-
2513
NIL
2614
27-
**CI Description**
15+
**PR relation**:
16+
- Ref #
17+
18+
**Which issue(s) this PR fixes**:
19+
You could link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.
20+
21+
- Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
22+
see [Linking a pull request to an issue using a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) or [Manually linking a pull request to an issue using the pull request sidebar](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-or-branch-to-an-issue-using-the-issue-sidebar)
23+
24+
-->
2825

29-
| CI Name | Description |
30-
| ----------------------------------------- | --------------------------------------------------------------- |
31-
| *Chaos CI* | Test the liveness and robustness of Axon under terrible network condition |
32-
| *Cargo Clippy* | Run `cargo clippy --all --all-targets --all-features` |
33-
| *Coverage Test* | Get the unit test coverage report |
34-
| *E2E Test* | Run end-to-end test to check interfaces |
35-
| *Code Format* | Run `cargo +nightly fmt --all -- --check` and `cargo sort -gwc` |
36-
| *Web3 Compatible Test* | Test the Web3 compatibility of Axon |
37-
| *v3 Core Test* | Run the compatibility tests provided by Uniswap V3 |
38-
| *OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19* | Run the compatibility tests provided by OpenZeppelin |
26+
<details><summary>CI Settings</summary><br/>
3927

40-
**CI Usage**
28+
<!-- Have I run `make ci`? -->
29+
### **CI Usage**
4130

42-
> Check the CI you want to run below, and then comment `/run-ci`.
31+
**Tip**: Check the CI you want to run below, and then comment `/run-ci`.
4332

4433
**CI Switch**
4534

46-
- [ ] Chaos CI
4735
- [ ] Cargo Clippy
4836
- [ ] Coverage Test
4937
- [ ] E2E Tests
@@ -55,3 +43,22 @@ NIL
5543
- [ ] OCT 11
5644
- [ ] OCT 16-19
5745
- [ ] v3 Core Tests
46+
47+
### **CI Description**
48+
49+
| CI Name | Description |
50+
| ----------------------------------------- | ------------------------------------------------------------------------- |
51+
| *Chaos CI* | Test the liveness and robustness of Axon under terrible network condition |
52+
| *Cargo Clippy* | Run `cargo clippy --all --all-targets --all-features` |
53+
| *Coverage Test* | Get the unit test coverage report |
54+
| *E2E Test* | Run end-to-end test to check interfaces |
55+
| *Code Format* | Run `cargo +nightly fmt --all -- --check` and `cargo sort -gwc` |
56+
| *Web3 Compatible Test* | Test the Web3 compatibility of Axon |
57+
| *v3 Core Test* | Run the compatibility tests provided by Uniswap V3 |
58+
| *OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19* | Run the compatibility tests provided by OpenZeppelin |
59+
60+
<!--
61+
#### Deprecated CIs
62+
- [ ] Chaos CI
63+
-->
64+
</details>

0 commit comments

Comments
 (0)