From cc97ad8f330aff43f412a95235a5386194803b14 Mon Sep 17 00:00:00 2001
From: Mark Waite <mark.earl.waite@gmail.com>
Date: Sun, 21 Jul 2024 17:41:14 -0600
Subject: [PATCH] Remove Jira issue from changelog summary in PR template
 (#9490)

When the Jira issue is included in the changelog summary, it is included
in the generated changelog as the initial text of the changelog entry.
The same issue link is then included by the changelog generator at the end
of the changelog description.  Remove the example that places the issue at
the start of the changelog text and explain that the issue link should be
elsewhere in the pull request so that the changelog generator can use it.

When the Jira issue is included in the changelog summary, the changelog
maintainers must remove it before the changelog is published.  It is
better to not include the Jira issue in the changelog summary so that
changelog maintainers do not need to remove it.

Remind submitters that they should not delete the upgrade guidelines
section because the presence of the upgrade guidelines section is used
by the changelog generator as the terminator for the proposed changelog
entries.
---
 .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 456f8fca6da7..a2ed88450df5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -28,16 +28,17 @@ For refactoring and code cleanup changes, exercise the code before and after the
 
 ### Proposed changelog entries
 
-- JENKINS-XXXXX, human-readable text
+- human-readable text
 
 <!-- Comment:
 The changelog entry should be in the imperative mood; e.g., write "do this"/"return that" rather than "does this"/"returns that".
 For examples, see: https://www.jenkins.io/changelog/
 
-Remove JENKINS-XXXXX if there is no issue for the pull request.
+Do not include the Jira issue in the changelog entry.
+Include the Jira issue in the description of the pull request so that the changelog generator can find it and include it in the generated changelog.
 
 You may add multiple changelog entries if applicable by adding a new entry to the list, e.g.
-- JENKINS-123456, First changelog entry
+- First changelog entry
 - Second changelog entry
 -->
 
@@ -45,6 +46,11 @@ You may add multiple changelog entries if applicable by adding a new entry to th
 
 N/A
 
+<!-- Comment:
+Leave the proposed upgrade guidelines in the pull request with the "N/A" value if no upgrade guidelines are needed.
+The changelog generator relies on the presence of the upgrade guidelines section as part of its data extraction process.
+-->
+
 ```[tasklist]
 ### Submitter checklist
 - [ ] The Jira issue, if it exists, is well-described.