Publish the held-back window where a reporter reads it - #199
Merged
Merged
Conversation
SECURITY.md said nothing about how long this board holds back its own record of a flaw it found in somebody else's software. Record 0022 decides 90 days from the report and one written extension on a reasoned request, and names SECURITY.md as where that window is published. Until now it existed only in the decision record, which is not a file a reporter or an affected project reads, so the window a project is entitled to plan against was invisible to it. The paragraphs go into the section about an experiment that finds a flaw in shipped software, because record 0010 already stands there and the window is the continuation of that rule. They point at record 0022 for the reasoning and the rejected options rather than restating either, so the copy cannot drift against the decision that a reader would find second. The second paragraph separates the window from the sentence under "What a reporter gets" saying there is no response deadline. Those two run in opposite directions and both stand: one is about a report arriving here, the other about a report leaving here. Without the separation written down, a reader meeting both reads the file as contradicting itself and has to guess which sentence governs. Closes #194 Signed-off-by: Nils Lehnen <30603423+iderex@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #194
What this changes
SECURITY.mdgains two paragraphs in the section "An experiment that finds aflaw in software somebody runs", immediately after the sentence saying what
comes back here once the flaw is fixed and the affected project has said what it
wants said.
The first states the window: 90 days from the report, published at the end of
them whether or not the fix and the statement have arrived, with exactly one
extension granted on a reasoned request and written down. It links
docs/decisions/0022-how-long-a-held-back-record-waits.mdfor the reasoning andthe rejected options rather than restating either, and it carries the one clause
of record
0022a reporter cannot infer from the window alone: where theaffected project publishes its own disclosure policy and this board has reported
into it, the earlier of the two dates binds here.
The second separates that window from the sentence already standing further down
under "What a reporter gets", which says there is no response deadline and there
will not be one. Both sentences stand and they run in opposite directions: one
is about a report arriving here, the other about a report leaving here.
No path leaves the tree in this change. It adds 22 lines to one file and removes
nothing:
The section is where these paragraphs go because record
0010already standsthere and the window is the continuation of that rule. Putting them under "What
a reporter gets" instead would have placed a window on what this board owes
others inside the section describing what others may expect from this board,
which is the confusion the second paragraph exists to prevent.
What failure it prevents
A reporter or an affected project being unable to read the date this board is
holding itself to. Record
0022decides the window and namesSECURITY.mdaswhere it is published; until this change it existed only in the decision record,
which is not a file either of them opens. A window nobody outside can read is
not something either side can plan against, and the silence around it is what
the record was written to end.
The second paragraph prevents a different failure, in the reader rather than in
the process.
SECURITY.mdsays there is no response deadline. Adding a 90-daywindow without saying which report each sentence is about leaves a file that
reads as contradicting itself, and a reader who has to guess which sentence
governs will guess the one that suits them.
What was run
At the commit being pushed,
d6ed552204000cc7063613b9d5728425711f4df8:The suite above was run without
-v, so the line that says what it did notcover is not in that output. It was run separately over the package that prints
it:
The four clauses of the done-condition, read at the same commit:
The last one is the separation clause: line 122 is the new paragraph naming the
sentence, and line 161 is the sentence it names, still standing unedited.
There is no second reader on this board tonight, and this body carries the
evidence in place of one rather than implying a review happened.
What this does not do
It builds no guard. Nothing in this repository refuses a
SECURITY.mdthatstops stating the window, and nothing counts a day against a held-back record.
The 90 days are held by whoever writes the record and by this file being read,
which is the same standing every other prose rule on this board has.
It does not add the
Held-back:field. Record0022says a held-back recordstays in
askingand carries that field, and that the listing prints it as itsown dated line. The field is in no source file on the default branch:
So the visibility half of record
0022is not delivered, this change does notdeliver it, and the paragraphs above claim nothing about what
lab listprints.That gap is on the tracker rather than only here.
It does not touch the reporting route. The private form named at the top of this
file is still off as a repository setting, which that part of the file already
states and this change leaves exactly as it found it.