Skip to content

Commit de47690

Browse files
Add guidelines for bulk reporting of issues
1 parent d253c47 commit de47690

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

security/policy.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _security-policy:
2+
13
===============
24
Security policy
35
===============

triage/issue-tracker.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ If you would like to file an issue about this devguide, please do so in the
2929
:github:`devguide repository <python/devguide>` instead.
3030

3131

32+
.. _checking-if-a-bug-already-exists:
33+
3234
Checking if a bug already exists
3335
--------------------------------
3436

@@ -92,6 +94,25 @@ and are covered in the :ref:`triaging` page. You don't need
9294
to worry about those when reporting issues as a Python user.
9395

9496

97+
Reporting many issues at once
98+
-----------------------------
99+
100+
Static analysis, fuzzing, and similar tools can produce a large number of
101+
findings. If you plan to report them in bulk:
102+
103+
* Run your analysis against the ``main`` branch, so that findings already
104+
fixed in development are excluded.
105+
* Check each finding against existing reports, see
106+
:ref:`checking-if-a-bug-already-exists` for more information.
107+
* Cross-check findings against the :ref:`security-policy`
108+
to make sure it is not a security vulnerability. Vulnerabilities must be
109+
reported privately, not on the issue tracker.
110+
* Rather than opening one issue per finding, open a single issue listing
111+
them all, and link to the full details (reproducers, tracebacks, logs)
112+
as `GitHub gists <https://gist.github.com/>`_. See :gh:`153852` for an
113+
example.
114+
115+
95116
Working with issues
96117
===================
97118

0 commit comments

Comments
 (0)