Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the properties of a high quality OSV record #2193

Open
wants to merge 39 commits into
base: master
Choose a base branch
from

Conversation

andrewpollock
Copy link
Contributor

@andrewpollock andrewpollock commented May 9, 2024

Reference from existing documentation on data.

Part of #2186

@andrewpollock andrewpollock deleted the document_quality_bar branch May 23, 2024 04:50
@andrewpollock andrewpollock restored the document_quality_bar branch May 23, 2024 05:01
@andrewpollock andrewpollock reopened this May 23, 2024
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
Copy link

@chrisbloom7 chrisbloom7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great doc! I left some very soft suggestions and nits along with a few grammatical fixes

docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Outdated Show resolved Hide resolved
docs/data_quality.md Show resolved Hide resolved
andrewpollock and others added 15 commits June 3, 2024 10:51
Co-authored-by: Jon <darakian@github.com>
Feedback was that it was possible to perceive this as known unfixed
vulnerabilities as being of lower quality than ones with known/available
fixes, and that is not the case, as such known unfixed vulnerabilities
can and do legitimately exist (as is the case when the vulnerable
package is orphaned). These are a legitimate true positive with no
available fixed version.
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
"Managing the Perishability of OSV Records" is in the early ideation
phase.
@andrewpollock
Copy link
Contributor Author

Great doc! I left some very soft suggestions and nits along with a few grammatical fixes

Thanks @chrisbloom7 I really appreciate you and @darakian taking the time to give it a thorough review, it's all the better for your time and effort.

@andrewpollock andrewpollock marked this pull request as ready for review June 3, 2024 01:23
Copy link

@chrisbloom7 chrisbloom7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Copy link

@darakian darakian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍

andrewpollock and others added 17 commits June 6, 2024 15:44
Co-authored-by: Jon <darakian@github.com>
Feedback was that it was possible to perceive this as known unfixed
vulnerabilities as being of lower quality than ones with known/available
fixes, and that is not the case, as such known unfixed vulnerabilities
can and do legitimately exist (as is the case when the vulnerable
package is orphaned). These are a legitimate true positive with no
available fixed version.
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
Co-authored-by: Chris Bloom <chrisbloom7@github.com>
"Managing the Perishability of OSV Records" is in the early ideation
phase.
I realised I'd omitted the `events[]` array in the JSON path when
talking about `introduced` and `fixed`/`last_affected`.

Explicitly refer to commits *and* versions when discussing temporal
ordering of `introduced` and `fixed`/`last_affected`.
Copy link

@SecurityCRob SecurityCRob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the clarification in the documentation. I think this will be very useful to the OSV community & downstream consumers.

andrewpollock and others added 2 commits June 10, 2024 00:43
Based on feedback from Duy Truong about Android's patching approach.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants