Skip to content

Commit d618e74

Browse files
authored
feat: Update pull request template (#52)
* feat: Update pull request template This commit fixes the spacing issue of the pull request checklist by changing the final checklist item. The relevant information now exists as a sentence after the list, as well as an additional line. The additional line, alongside a similar one added to the checklist, direct the reader to our style guide to review specific guidance that would otherwise be too verbose to add to the template.
1 parent 647c09c commit d618e74

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

.github/pull_request_template.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,18 @@ Closes #ISSUE
1919

2020
### Checklist
2121

22-
Before creating a PR, run through this checklist and mark each as complete.
23-
24-
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
25-
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
26-
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
27-
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
28-
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md))
29-
- [ ] I have rebased my branch onto main
30-
- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
31-
- [ ] If the change involves:
32-
- Code
33-
- Anything that resembles Personally identifying information (PII)
34-
- Make sure to use placeholders such as `<username>` in place of PII
35-
- URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0))
36-
- Significant new/revised content
37-
38-
In these cases, the change will require at least two (2) approvals before merging
22+
Before merging a pull request, run through this checklist and mark each as complete.
23+
24+
- [] I have read the [contributing guidelines](/CONTRIBUTING.md)
25+
- [] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
26+
- [] I have ensured that documentation content adheres to [the style guide](/templates/style-guide.md)
27+
- [] If the change involves potentially sensitive changes, I have assessed the possible impact
28+
- [] If applicable, I have added tests that prove my fix is effective or that my feature works
29+
- [] If applicable, I have checked that any relevant tests pass after adding my changes
30+
- [] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md))
31+
- [] I have rebased my branch onto main
32+
- [] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
33+
34+
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.
35+
36+
Please refer to [our style guide](/templates/style-guide.md) for guidance about placeholder content.

0 commit comments

Comments
 (0)