Skip to content

Commit 39cd2f2

Browse files
authored
Improve the pull request template (#1625)
1 parent fd299e8 commit 39cd2f2

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

.github/pull_request_template.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
Description
2-
-----------
3-
<!-- Description of the change -->
1+
## Description
42

3+
<!-- Uncomment and add a description of the change -->
54

6-
Related issues
7-
-----------
8-
- Fixes DOCS-12345 <!-- JIRA issue, or remove this line -->
9-
- Fixes #12345 <!-- GitHub issue, or remove this line -->
105

6+
<!-- Optionally, uncomment the heading and add details about how you tested the change and how reviewers should test it. For example:
7+
## Testing
8+
- [ ] Local build succeeds without errors or broken internal links (`hugo server`)
9+
- [ ] PR tests succeed
10+
- [ ] The Lychee Github action run against the PR branch reports no broken links
11+
12+
Replace the `[ ]` with `[x]` to check off the item instead of leaving it unchecked.
13+
14+
Otherwise, delete this entire section from opening to closing comment.
15+
-->
16+
17+
<!-- Optionally, uncomment the heading and add one or more lines like these. Otherwise, delete this entire section from opening to closing comment.
18+
19+
## Related issues
20+
21+
- Fixes DOCS-12345
22+
- Fixes #12345
23+
-->

0 commit comments

Comments
 (0)