|
1 | 1 | ### Proposed changes |
2 | 2 |
|
3 | | -Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the |
4 | | -following format: |
| 3 | +[//]: # "Write a clear and concise description of what the pull request changes." |
| 4 | +[//]: # "You can use our Commit messages guidance for this." |
| 5 | +[//]: # "https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md#commit-messages" |
5 | 6 |
|
6 | | -Problem: Give a brief overview of the problem or feature being addressed. |
| 7 | +[//]: # "First, explain what was changed, and why. This should be most of the detail." |
| 8 | +[//]: # "Then how the changes were made, such as referring to existing styles and conventions." |
| 9 | +[//]: # "Finish by noting anything beyond the scope of the PR changes that may be affected." |
7 | 10 |
|
8 | | -Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or |
9 | | -considerations. |
| 11 | +[//]: # "Include information on testing if relevant and non-obvious from the deployment preview." |
| 12 | +[//]: # "For expediency, you can use screenshots to show small before and after examples." |
10 | 13 |
|
11 | | -Testing: Describe any testing that you did. |
| 14 | +[//]: # "If the changes were defined by a GitHub issue, reference it using keywords." |
| 15 | +[//]: # "https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests" |
12 | 16 |
|
13 | | -Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide |
14 | | -specific feedback, add them here. |
15 | | - |
16 | | -If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here: |
17 | | - |
18 | | -Closes #ISSUE |
| 17 | +[//]: # "Do not like to any internal, non-public resources. This includes internal repository issues or anything in an intranet." |
| 18 | +[//]: # "You can make reference to internal discussions without linking to them: see 'Referencing internal information'." |
| 19 | +[//]: # "https://github.com/nginx/documentation/blob/main/documentation/closed-contributions.md#referencing-internal-information" |
19 | 20 |
|
20 | 21 | ### Checklist |
21 | 22 |
|
22 | | -Before merging a pull request, run through this checklist and mark each as complete. |
| 23 | +Before sharing this pull request, I completed the following checklist: |
23 | 24 |
|
24 | | -- [ ] I have read the [contributing guidelines](https://github.com/nginx/documentation/blob/main/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 rebased my branch onto main |
27 | | -- [ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork |
28 | | -- [ ] I have ensured that the commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) |
29 | | -- [ ] I have ensured that documentation content adheres to [the style guide](/documentation/style-guide.md) |
30 | | -- [ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact |
31 | | -- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works |
32 | | -- [ ] I have ensured that existing tests pass after adding my changes |
33 | | -- [ ] If applicable, I have updated [`README.md`](/README.md) |
| 25 | +- [ ] I read the [Contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md) |
| 26 | +- [ ] My branch adheres to the [Git conventions](https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md) |
| 27 | +- [ ] My content changes adhere to the [F5 NGINX Documentation style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md) |
| 28 | +- [ ] If my changes involve potentially sensitive information[^1], I have assessed the possible impact |
| 29 | +- [ ] I have waited to ensure my changes pass tests, and addressed any discovered issues |
34 | 30 |
|
35 | | -[^1]: 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](/documentation/style-guide.md) for guidance about placeholder content. |
| 31 | +[^1]: Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the [style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md) for guidance about placeholder content. |
0 commit comments