doc: Add note to changelog to use PR numbers (#4801)

cobaltt7 · web-flow · commit e97cf5bdbc87 · 2025-10-19T16:50:47.000-05:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+<!-- PR authors:
+     Please include the PR number in the changelog entry, not the issue number -->
+
 ### Highlights
 
 <!-- Include any especially major or disruptive changes here -->
diff --git a/scripts/release.py b/scripts/release.py
@@ -1,11 +1,11 @@
 #!/usr/bin/env python3
 
-from __future__ import annotations
-
 """
 Tool to help automate changes needed in commits during and after releases
 """
 
+from __future__ import annotations
+
 import argparse
 import logging
 import re
@@ -18,6 +18,9 @@
 NEW_VERSION_CHANGELOG_TEMPLATE = """\
 ## Unreleased
 
+<!-- PR authors:
+     Please include the PR number in the changelog entry, not the issue number -->
+
 ### Highlights
 
 <!-- Include any especially major or disruptive changes here -->
