chore: simplify PULL_REQUEST_TEMPLATE (#1327)

axonweb3 · Aug 16, 2023 · 1e49257 · 1e49257
1 parent 148a302
commit 1e49257
Showing 1 changed file with 37 additions and 30 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,49 +1,37 @@
 <!--  Thanks for sending a pull request! -->
-<!--  Have I run `make ci`? -->
-
-**What this PR does / why we need it**:
-
-This PR
 
-**Which issue(s) this PR fixes**:
-<!--
-*Automatically closes linked issue when PR is merged.
-Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
--->
-Fixes #
+## What this PR does / why we need it?
 
-**Which docs this PR relation**:
+This PR ...
 
-Ref #
-
-**Which toolchain this PR adaption**:
+### What is the impact of this PR?
 
 No Breaking Change
 
+<!--
 **Special notes for your reviewer**:
-
 NIL
 
-**CI Description**
+**PR relation**:
+- Ref #
+
+**Which issue(s) this PR fixes**:
+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.
+
+- Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
+  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)
+
+-->
 
-| CI Name                                   | Description                                                     |
-| ----------------------------------------- | --------------------------------------------------------------- |
-| *Chaos CI*                                | Test the liveness and robustness of Axon under terrible network condition    |
-| *Cargo Clippy*                            | Run `cargo clippy --all --all-targets --all-features`      |
-| *Coverage Test*                           | Get the unit test coverage report                             |
-| *E2E Test*                                | Run end-to-end test to check interfaces                         |
-| *Code Format*                             | Run `cargo +nightly fmt --all -- --check` and `cargo sort -gwc`     |
-| *Web3 Compatible Test*                    | Test the Web3 compatibility of Axon                               |
-| *v3 Core Test*                            | Run the compatibility tests provided by Uniswap V3             |
-| *OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19* | Run the compatibility tests provided by OpenZeppelin           |
+<details><summary>CI Settings</summary><br/>
 
-**CI Usage**
+<!--  Have I run `make ci`? -->
+### **CI Usage**
 
-> Check the CI you want to run below, and then comment `/run-ci`.
+**Tip**: Check the CI you want to run below, and then comment `/run-ci`.
 
 **CI Switch**
 
-- [ ] Chaos CI
 - [ ] Cargo Clippy
 - [ ] Coverage Test
 - [ ] E2E Tests
@@ -55,3 +43,22 @@ NIL
 - [ ] OCT 11
 - [ ] OCT 16-19
 - [ ] v3 Core Tests
+
+### **CI Description**
+
+| CI Name                                   | Description                                                               |
+| ----------------------------------------- | ------------------------------------------------------------------------- |
+| *Chaos CI*                                | Test the liveness and robustness of Axon under terrible network condition |
+| *Cargo Clippy*                            | Run `cargo clippy --all --all-targets --all-features`                     |
+| *Coverage Test*                           | Get the unit test coverage report                                         |
+| *E2E Test*                                | Run end-to-end test to check interfaces                                   |
+| *Code Format*                             | Run `cargo +nightly fmt --all -- --check` and `cargo sort -gwc`           |
+| *Web3 Compatible Test*                    | Test the Web3 compatibility of Axon                                       |
+| *v3 Core Test*                            | Run the compatibility tests provided by Uniswap V3                        |
+| *OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19* | Run the compatibility tests provided by OpenZeppelin                      |
+
+<!--
+#### Deprecated CIs
+- [ ] Chaos CI
+-->
+</details>