Skip to content

Commit 44c35f0

Browse files
committed
chore: update new fragment template to include the pr number
1 parent 0f29877 commit 44c35f0

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Added
22
~~~~~
3-
* Migrate to scriv to manage changelog. (by @bryanttv)
3+
* Migrate to scriv to manage changelog. (by @bryanttv in #472)

changelog.d/scriv/new_fragment.rst.j2

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
.. Please respect the following instructions:
44
.. * Add a new bullet item for the category that best describes the change.
5-
.. * You may optionally append "(by @<author>)" at the end of the bullet item,
6-
.. where @<author> is the GitHub username of the author of the change. These
7-
.. affiliations will be displayed in the release notes for every release.
5+
.. * You may optionally append "(by @<author> in #<pr-number>)" at the end of
6+
.. the bullet item. This will be used to credit the PR author in the bullet
7+
.. item, where <author> is the GitHub username of the author of the change
8+
.. and <pr-number> is the PR number of the change. These affiliations will
9+
.. be displayed in the release notes for every release.
810
.. * The accepted categories are: Added, Changed, Deprecated, Removed, Fixed,
911
.. and Security.
1012
.. * Indicate breaking changes with a "**BREAKING CHANGE:**" prefix in the
@@ -15,27 +17,27 @@
1517
.. Added
1618
.. ~~~~~
1719
.. * Added new ``COURSE_DOWNLOADED_COMPLETED`` event.
18-
.. * Added support for annotated Python dictionaries as Avro Map type. (by @developer)
20+
.. * Added support for annotated Python dictionaries as Avro Map type. (by @developer in #1)
1921

2022
.. Changed
2123
.. ~~~~~~~
2224
.. * Added support for Python 3.12.
23-
.. * **BREAKING CHANGE:** Updated from Django 3.x to 4.x. (by @developer)
25+
.. * **BREAKING CHANGE:** Updated from Django 3.x to 4.x. (by @developer #2)
2426

2527
.. Deprecated
2628
.. ~~~~~~~~~~
2729
.. * Deprecated ``COURSE_DOWNLOADED_STARTED`` event
28-
.. * Deprecated use of non-annotated dictionaries in events. (by @developer)
30+
.. * Deprecated use of non-annotated dictionaries in events. (by @developer #3)
2931

3032
.. Removed
3133
.. ~~~~~~~
3234
.. * Removed support for Python 3.8.
33-
.. * Removed unused ``COURSE_DOWNLOADED_STARTED`` event. (by @developer)
35+
.. * Removed unused ``COURSE_DOWNLOADED_STARTED`` event. (by @developer #4)
3436

3537
.. Fixed
3638
.. ~~~~~
3739
.. * Fixed event validation in background processes.
38-
.. * Fixed incorrect handling of event payloads. (by @developer)
40+
.. * Fixed incorrect handling of event payloads. (by @developer #4)
3941

4042
.. Security
4143
.. ~~~~~~~~

0 commit comments

Comments
 (0)