Skip to content

Commit 4a09f9f

Browse files
committed
Get the release notes from the pull request description automatically using a bot
The bot (https://github.com/sympy/sympy-bot) automatically checks every pull request to make sure there is a valid release notes entry in the description. The release notes entry should placed between the `<!-- BEGIN RELEASE NOTES -->` lines and be formatted like ``` * solvers * improved logarithmic solving ``` In other words, each release note entry should have a heading with the submodule that was changed, or `other`, and have a bulleted list of the changes. I have written a guide on how to write release notes at https://github.com/sympy/sympy/wiki/Writing-Release-Notes. Whenever a new pull request is made, or the description is edited, the bot will automatically check the release notes to see if they are formatted correctly. When the pull request is merged, the bot will automatically take the parsed release notes and add them to the release notes on the wiki. Any suggestions on the wording here or in the bot are welcome.
1 parent c96a971 commit 4a09f9f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

PULL_REQUEST_TEMPLATE.md

+13
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,16 @@ https://github.com/blog/1506-closing-issues-via-pull-requests .-->
1111

1212

1313
#### Other comments
14+
15+
16+
#### Release Notes
17+
18+
<!-- Write the release notes for this release below. See
19+
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
20+
on how to write release notes. If there is no release notes entry for this PR,
21+
write "NO ENTRY". The bot will check your release notes automatically to see
22+
if they are formatted correctly. -->
23+
24+
<!-- BEGIN RELEASE NOTES -->
25+
26+
<!-- END RELEASE NOTES -->

0 commit comments

Comments
 (0)