]> git.kaiwu.me - nginx.git/commitdiff
GH: update the GitHub pull-request template
authorAndrew Clayton <a.clayton@nginx.com>
Thu, 5 Mar 2026 01:34:29 +0000 (01:34 +0000)
committerAndrew Clayton <a.clayton@nginx.com>
Fri, 24 Apr 2026 16:33:41 +0000 (17:33 +0100)
.github/pull_request_template.md

index 1e7e0a9d7f342420560a3f99652d54bfb03edbb7..c2aa3575713275a802ec78709c7f9958c6d69c72 100644 (file)
@@ -1,10 +1,36 @@
-### Proposed changes
+## Problem
 
-Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) in this PR's description or commit message.
+Briefly describe the issue or feature being addressed.
 
-### Checklist
+## Solution
 
-Before creating a PR, run through this checklist and mark each as complete:
+Explain your approach and any important design decisions.
 
-- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md).
-- [ ] I have checked that NGINX compiles and runs after adding my changes.
+## Testing
+
+Describe how you tested the change (manual testing, automated tests,
+regression tests, etc.).
+
+- [ ] Manual Testing
+- [ ] Functional Testing ([nginx-tests](https://github.com/nginx/nginx-tests))
+
+**Closes:** #ISSUE\_NUMBER
+
+## Checklist
+
+Before submitting this PR, please confirm:
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/nginx/nginx/blob/master/CONTRIBUTING.md) guidelines
+- [ ] I have added tests (if applicable) to validate my changes
+- [ ] All existing tests pass
+- [ ] I have updated documentation where necessary
+- [ ] My branch is rebased on the latest master
+- [ ] This PR targets the master branch from my fork
+- [ ] My commit message follows NGINX standards (imperative mood, clear
+      subject, references related issue if applicable, and contains only
+      relevant changes)
+
+## Release Notes
+
+If this change affects users, please add a short note here describing
+the impact for release documentation.