cisagov / log4j-affected-db

A community sourced list of log4j-affected software
Creative Commons Zero v1.0 Universal
1.12k stars 281 forks source link

Contributing adjustments #425

Closed iainDe closed 2 years ago

iainDe commented 2 years ago

๐Ÿ—ฃ Description

๐Ÿ’ญ Motivation and context

๐Ÿงช Testing

โœ… Pre-approval checklist

โœ… Pre-merge checklist

โœ… Post-merge checklist

iainDe commented 2 years ago

Let me know if this is satisfactory documentation to future contributors. From the CONTRIBUTING.md users would navigate the link to PULL-EXAMPLE.md

iainDe commented 2 years ago

I would suggest this section could be removed:

"Note: we are tracking multiple CVEs on the backend but are currently only displaying all the CVE-2021-44228. The multiple CVEs will not be listed in the table per the current request, instead the logic will determine and present a single status based on the available data in the template. "

That was included in the notes for context, but we probably don't need to keep it in the contributing doc - especially if we are expecting there may be some PRs for the other related CVEs moving forward.

The reporter field should also be removed from the template and example, since this field will be machine generated moving forward: " reporter: cisagov"

@chelsgr Changes made as suggested to the PULL-EXAMPLE.md. Eliminated the comment on tracking CVEs on the backend, and removed the two instances of the reporter being a tracked field. Feel free to make the Merge when appropriate