From ae6cc53bfcc7c4a038f36510e139ee3c92d3040b Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 7 Jan 2025 15:43:31 -0700 Subject: [PATCH 1/2] 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. --- .github/pull_request_template.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 268a3b202..63fb7e539 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -21,18 +21,16 @@ Closes #ISSUE Before creating a PR, run through this checklist and mark each as complete. -- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) -- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) -- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works -- [ ] If applicable, I have checked that any relevant tests pass after adding my changes -- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) -- [ ] I have rebased my branch onto main -- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork -- [ ] If the change involves: - - Code - - Anything that resembles Personally identifying information (PII) - - Make sure to use placeholders such as `` in place of PII - - URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0)) - - Significant new/revised content - - In these cases, the change will require at least two (2) approvals before merging +- [] I have read the [contributing guidelines](/CONTRIBUTING.md) +- [] I have ensured that documentation content adheres to [the style guide](/templates/style-guide.md) +- [] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) +- [] If applicable, I have added tests that prove my fix is effective or that my feature works +- [] If applicable, I have checked that any relevant tests pass after adding my changes +- [] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) +- [] I have rebased my branch onto main +- [] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork +- [] If the change involves potentially sensitive changes, I have waited for 2 approvals before merging + +Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. + +Please refer to [our style guide](/templates/style-guide.md) for guidance about placeholder content. \ No newline at end of file From 2fe0863655c8f824073efb2ba8a086c5e6dbdfe1 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 7 Jan 2025 15:43:31 -0700 Subject: [PATCH 2/2] 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. --- .github/pull_request_template.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 268a3b202..8bc97cf91 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -19,20 +19,18 @@ Closes #ISSUE ### Checklist -Before creating a PR, run through this checklist and mark each as complete. - -- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) -- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) -- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works -- [ ] If applicable, I have checked that any relevant tests pass after adding my changes -- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) -- [ ] I have rebased my branch onto main -- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork -- [ ] If the change involves: - - Code - - Anything that resembles Personally identifying information (PII) - - Make sure to use placeholders such as `` in place of PII - - URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0)) - - Significant new/revised content - - In these cases, the change will require at least two (2) approvals before merging +Before merging a pull request, run through this checklist and mark each as complete. + +- [] I have read the [contributing guidelines](/CONTRIBUTING.md) +- [] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) +- [] I have ensured that documentation content adheres to [the style guide](/templates/style-guide.md) +- [] If the change involves potentially sensitive changes, I have assessed the possible impact +- [] If applicable, I have added tests that prove my fix is effective or that my feature works +- [] If applicable, I have checked that any relevant tests pass after adding my changes +- [] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) +- [] I have rebased my branch onto main +- [] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork + +Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. + +Please refer to [our style guide](/templates/style-guide.md) for guidance about placeholder content. \ No newline at end of file