Skip to content

Commit a4b4dae

Browse files
sethmlarsonStanFromIrelandhugovk
authored
Apply suggestions from code review
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 7434dcf commit a4b4dae

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

developer-workflow/psrt.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,12 @@ to be responsible for moving the report through the process.
108108
The "Coordinator" role is assigned using a "Credit" in a GHSA ticket
109109
(Select 'Edit' > 'Credit' > Add GitHub username and the role 'Coordinator').
110110

111-
If a GHSA ticket is idle for 3 days without a coordinator
112-
assigned a non-"Release Manager" / "Steering Council"
113-
PSRT member will be automatically assigned as coordinator by the PSRT bot.
111+
If a GHSA ticket is idle for three days without a coordinator
112+
assigned a PSRT member who is not a Release Manager
113+
or Steering Council member will be automatically assigned
114+
as coordinator by the PSRT bot.
114115
If a coordinator can't complete the process
115-
they must find a replacement coordinator in the PSR
116+
they must find a replacement coordinator in the PSRT
116117
and re-assign the GHSA ticket.
117118

118119
Determining whether a report is a vulnerability
@@ -124,7 +125,7 @@ Determining whether a report is a vulnerability
124125
The coordinator will make a determination about a report, either
125126
marking the ticket as a non-issue, as an issue that isn't a security
126127
vulnerability, or as a security vulnerability. If the Coordinator needs
127-
help from core team member experts in making the determination, the
128+
help from core team experts in making the determination, the
128129
experts may be added as 'Collaborators' to the GHSA ticket.
129130
Accepted security vulnerabilities will be moved to the 'Draft' state in GHSA.
130131

@@ -172,7 +173,7 @@ Developing a patch privately
172173

173174
Patch development can initially be done privately by selecting the
174175
'Start a temporary private fork' button within the GHSA ticket. Note that
175-
due to the size of git repositories, this fork repository may
176+
due to the size of Git repositories, this fork repository may
176177
take several minutes to create. Once the fork has been created any PSRT member
177178
or GHSA collaborator can clone the fork and develop a fix and push a branch:
178179

@@ -195,7 +196,7 @@ Once the patch has been approved
195196
a public GitHub issue and pull request can be opened.
196197
Generate a blurb in the category ``Security`` for the public pull request.
197198
Public issues and pull requests for security fixes should use the
198-
``type-security`` label.
199+
:gh-label:`type-security` label.
199200

200201
To quickly pull a patch file from a GHSA pull request, you
201202
can append ``.patch`` to the pull request URL, like so:
@@ -232,9 +233,10 @@ This patch can then be applied and pushed to the public GitHub repository:
232233
Publishing an advisory
233234
~~~~~~~~~~~~~~~~~~~~~~
234235

235-
Once the vulnerability fix has been merged in a public GitHub into the ``main``
236-
branch, an advisory must be published. The advisory requires the severity,
237-
a title, and a short description of the vulnerable module, function(s),
236+
Once the vulnerability fix has been merged into the main branch via a
237+
public GitHub pull request, an advisory must be published.
238+
The advisory requires the severity,
239+
a title, and a short description of the vulnerable module, functions,
238240
behavior and fix. This short description can optionally include mitigation steps
239241
if applying the patch isn't the only way to mitigate the vulnerability.
240242

@@ -243,9 +245,9 @@ if applying the patch isn't the only way to mitigate the vulnerability.
243245
* The advisory email will be received by PSF CVE Numbering Authority
244246
operators and used to publish a CVE record.
245247
* Begin the backporting process for all Python branches still receiving
246-
security updates. Add the ``type-security`` and ``release-blocker`` labels
248+
security updates. Add the :gh-label:`type-security` and :gh-label:`release-blocker` labels
247249
to each backport pull request so that release managers can find them prior
248-
to releases.
250+
to releasing.
249251

250252
After an advisory email is sent, the GHSA ticket can be closed.
251253

0 commit comments

Comments
 (0)