Skip to content

Commit 8d30984

Browse files
authored
docs: Improve pull request template (#2508)
## What does this PR do? * Reorganize PR template sections for clarity. * Add "Why?" section to explain PR purpose. * Update instructions for linking related issues to include "Fixes". * Add note about deleting sections if not applicable.
1 parent 645faf5 commit 8d30984

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

.github/pull_request_template.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,30 @@ Contribution Checklist
99
1010
- Fory has a strong focus on performance. If the PR you submit will have an impact on performance, please benchmark it first and provide the benchmark result here.
1111
-->
12+
## Why?
13+
14+
<!-- Describe the purpose of this PR. -->
1215

1316
## What does this PR do?
1417

15-
<!-- Describe the purpose of this PR. -->
18+
<!-- Describe the details of this PR. -->
1619

1720
## Related issues
1821

1922
<!--
20-
Is there any related issue? Please attach here.
23+
Is there any related issue? If this PR closes them you say say fix/closes:
2124
2225
- #xxxx0
2326
- #xxxx1
24-
- #xxxx2
27+
- Fixes #xxxx2
2528
-->
2629

2730
## Does this PR introduce any user-facing change?
2831

2932
<!--
3033
If any user-facing interface changes, please [open an issue](https://github.com/apache/fory/issues/new/choose) describing the need to do so and update the document if necessary.
34+
35+
Delete section if not applicable.
3136
-->
3237

3338
- [ ] Does this PR introduce any public API change?
@@ -37,4 +42,6 @@ If any user-facing interface changes, please [open an issue](https://github.com/
3742

3843
<!--
3944
When the PR has an impact on performance (if you don't know whether the PR will have an impact on performance, you can submit the PR first, and if it will have impact on performance, the code reviewer will explain it), be sure to attach a benchmark data here.
45+
46+
Delete section if not applicable.
4047
-->

0 commit comments

Comments
 (0)