Skip to content

Commit 19fa217

Browse files
committed
Polish NEWS prompt formatting
1 parent f57842c commit 19fa217

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

templates/add_blurb.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,16 @@ <h5 class="modal-title" id="aiPromptModalLabel">Prompt for AI to write NEWS entr
119119
return [
120120
"Please draft exactly one CPython Misc/NEWS entry for the following change.",
121121
"",
122-
"Context links:",
122+
"## Context links",
123123
"- GitHub issue: " + issueUrl,
124124
"- GitHub pull request: " + prUrl,
125125
"- Pull request diff: " + diffUrl,
126126
"- Changed files API: " + filesUrl,
127127
"",
128-
"Target NEWS section: " + sectionText,
128+
"## Target NEWS section",
129+
sectionText,
129130
"",
130-
"Instructions:",
131+
"## Instructions",
131132
"- Read the issue, pull request, diff, and changed files before drafting.",
132133
"- First decide whether this change needs a NEWS entry.",
133134
"- A NEWS entry is usually not needed for documentation changes, test changes, strictly internal changes with no user-visible effects, or changes that already have a NEWS entry.",
@@ -140,6 +141,8 @@ <h5 class="modal-title" id="aiPromptModalLabel">Prompt for AI to write NEWS entr
140141
"",
141142
"The contents of a `NEWS` file should be valid reStructuredText. An 80 character column width should be used. There is no indentation or leading marker in the file, for example `-`. There is also no need to start the entry with the issue number since it is part of the file name. You can use inline markups too. Here is an example of a `NEWS` entry:",
142143
"",
144+
"Do not add `Patch by`, `Patched by`, or `Contributed by` attribution unless the existing issue or pull request clearly requires it and the contributor name is reliable.",
145+
"",
143146
"```rst",
144147
"Fix warning message when :func:`os.chdir` fails inside",
145148
":func:`test.support.temp_cwd`. Contributed by Chris Jerdonek.",

0 commit comments

Comments
 (0)