Skip to content

Commit 2033a37

Browse files
committed
Document source-bearing issue drafts
* Explain the explicit disclosure option and its privacy risks. * Describe bounded failed-block and duplicate-key reproductions without truncation.
1 parent a58e75e commit 2033a37

2 files changed

Lines changed: 36 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,19 @@ output remains representable in the selected encoding. It reports exact source
8686
byte identity separately because normal writing may intentionally normalize
8787
layout. Use `--json` for applications.
8888

89-
An incompatible result includes a reviewable GitHub issue-draft URL by default.
90-
Constructing the URL does not open a browser, make a network request, or create
91-
an issue. No file path, bibliography content, or source snippet is included;
92-
users must review the draft and add only a safe minimal reproduction. Use
93-
`--no-issue-link` to suppress it.
89+
An incompatible result includes a reviewable, privacy-safe GitHub issue-draft
90+
URL by default. Constructing the URL does not open a browser, make a network
91+
request, or create an issue. No file path, bibliography content, or source
92+
snippet is included.
93+
94+
The same report explains how to rerun with
95+
`--include-source-in-issue-link`. That explicit opt-in retains the privacy-safe
96+
draft and adds a second draft containing an exact failed block when the checker
97+
can extract a bounded reproduction. For duplicate keys, it includes both
98+
relevant blocks. It never truncates a block into a potentially invalid example.
99+
The second URL exposes bibliography source in terminal logs, browser history,
100+
and the GitHub draft, so review all three before submission. Use
101+
`--no-issue-link` to suppress issue links entirely.
94102

95103
A passing result means that the file passed the named checks with this version;
96104
it is not a proof that no unanticipated interpretation bug can exist.

‎docs/source/quickstart.rst‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -196,12 +196,29 @@ The thorough preflight is opt-in because it parses twice and writes twice.
196196
Ordinary parsing continues to log detected block failures and exposes them in
197197
``library.failed_blocks`` without paying that additional cost on every read.
198198

199-
On incompatibility, the text and JSON CLI reports include a pre-filled GitHub
200-
issue-form URL unless ``--no-issue-link`` is supplied. The URL is only a draft:
201-
the command does not open it, perform a network request, or create an issue. It
202-
contains environment and check metadata plus a source hash, but no file path,
203-
bibliography content, or source snippet. Review the draft and add only a minimal
204-
example that is safe to disclose.
199+
On incompatibility, the text and JSON CLI reports include a pre-filled,
200+
privacy-safe GitHub issue-form URL unless ``--no-issue-link`` is supplied. The
201+
URL is only a draft: the command does not open it, perform a network request, or
202+
create an issue. It contains environment and check metadata plus a source hash,
203+
but no file path, bibliography content, or source snippet.
204+
205+
The text report also points to the explicit source-disclosure option:
206+
207+
.. code-block:: console
208+
209+
$ python -m bibtexparser check references.bib --include-source-in-issue-link
210+
211+
That command keeps the privacy-safe draft and adds a second draft containing an
212+
exact failed block when the checker can extract a bounded reproduction. A
213+
duplicate-key reproduction includes both relevant blocks. The checker does not
214+
truncate an oversized block, because a partial block could be invalid or fail
215+
to reproduce the problem; in that case, add a reviewed minimal example
216+
manually.
217+
218+
The source-bearing URL exposes bibliography content in terminal logs, browser
219+
history, and the GitHub draft even if the issue is never submitted. The command
220+
therefore requires explicit opt-in and prints a warning. Review the URL and the
221+
draft carefully before submitting anything.
205222

206223
.. _writing_quickstart:
207224

0 commit comments

Comments
 (0)