From: Dave Miller <justdave@bugzilla.org>
Date: Mon, 26 Aug 2024 01:29:04 +0000 (-0400)
Subject: Bug 1897545: More user-friendly pull request template (#187)
X-Git-Tag: bugzilla-5.2~8
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=591636a92f2ecc822eb353fabaa53f02ab4bff14;p=thirdparty%2Fbugzilla.git

Bug 1897545: More user-friendly pull request template (#187)

a=dylan
---

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index ba470cf5e..f6e5b3b6f 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,12 +1,24 @@
+<!--
+
+#### Instructions
+
+1. All pull requests to an officially supported branch must be accompanied by a bug report on bugzilla.mozilla.org. Please stop and file one there if you haven't already, or look for an existing one that fits what you're doing (the bug entry form will automatically search for things that look similar to the Summary you enter).
+   File a bug report: https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla
+2. GitHub will automatically attach your pull request to the bug report in Bugzilla if you have "Bug #######" in the title of the pull request, where ####### is the bug number. For readability, we recommend putting it at the beginning of the title.
+3. If it's not otherwise obvious from the title which branch the pull request applies to, please put the name of the branch in square brackets at the beginning of the title.
+
+ Example title:
+   [5.2] Bug 1234: Change Foo to do Bar
+-->
+
 #### Details
 <!-- Explain what you did -->
 This PR fixes/adds a feature...
 
 #### Additional info
+<!-- Paste the bug number after the # and after the = in the following line. -->
 * [bug#](https://bugzilla.mozilla.org/show_bug.cgi?id=)
 
-NOTE: Bug number is required. If you haven't filed a bug on https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla yet, don't submit the Pull Request. Please edit the above link to put the bug number both immediately after the # character and after the = character at the end. You can delete this paragraph once you've added your bug number.
-
 #### Test Plan
 <!-- How did you verify the fix/feature in steps -->
 1. Open the show_bug view