Add scoring doc, update readme - #83
Conversation
andrew
left a comment
There was a problem hiding this comment.
-
The confidence ranges in
SCORING.mddo not match the implementation. A score of0has confidencenone, notlow, and scores above100remainhigh. Please document the ranges asnone = 0,low = 1–30,medium = 31–70, andhigh = 71+. The related issue link on line 3 also points to the old repository and returns 404. -
Issue #66 asks for CLI examples and this PR says it closes that issue, but
SCORING.mdonly contains a commit example. Please add examples showing the default scoring output and how to use--confidence-levels. -
The detector summary says both
Co-Authored-ByandAssisted-Byrequire known AI tool emails. OnlyCo-Authored-Bychecks known emails.Assisted-Byaccepts any non-empty tool name, so please describe these separately.
MoralCode
left a comment
There was a problem hiding this comment.
changing my blocking to neutral. Andrews feedback should still be addressed though. will re-review and read through the content after that
andrew
left a comment
There was a problem hiding this comment.
The disclosure text example in SCORING.md cannot be run as written: the text command does not accept --confidence-levels, and its JSON output has top-level findings, score, and confidence fields rather than the combined commits/text action report. Could you update the example using output captured from the command?
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
151b731 to
bf07363
Compare
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
Thanks @andrew, these things are fixed. I've also added one more example and kept them all consistently in text (not json) format for readability, and added a basic explanation below each one's output. |
|
🚢 |
Description
Add scoring doc, update readme
This PR closes #66, #69. By addition of SCORING.md, it potentially also resolves #49.
Notes for Reviewers
Signed commits
Generative AI disclosure
Please select one option:
If AI tools were used, please provide details below:
- What tools were used?
- How were these tools used?
- Did you review these outputs before submitting this PR?