Skip to content

Add scoring doc, update readme - #83

Merged
omkar-foss merged 4 commits into
chaoss:mainfrom
omkar-foss:update-readme
Aug 21, 2026
Merged

Add scoring doc, update readme#83
omkar-foss merged 4 commits into
chaoss:mainfrom
omkar-foss:update-readme

Conversation

@omkar-foss

Copy link
Copy Markdown
Contributor

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

  • Yes, I signed my commits.

Generative AI disclosure

Please select one option:

  • This contribution was NOT assisted or created by Generative AI tools.
  • This contribution was assisted or created by Generative AI tools.

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?

@andrew andrew left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • The confidence ranges in SCORING.md do not match the implementation. A score of 0 has confidence none, not low, and scores above 100 remain high. Please document the ranges as none = 0, low = 1–30, medium = 31–70, and high = 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.md only 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-By and Assisted-By require known AI tool emails. Only Co-Authored-By checks known emails. Assisted-By accepts any non-empty tool name, so please describe these separately.

Comment thread SCORING.md
Comment thread SCORING.md
@MoralCode MoralCode added this to the 1.0 milestone Aug 19, 2026

@MoralCode MoralCode left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

changing my blocking to neutral. Andrews feedback should still be addressed though. will re-review and read through the content after that

@omkar-foss

Copy link
Copy Markdown
Contributor Author

changing my blocking to neutral. Andrews feedback should still be addressed though. will re-review and read through the content after that

Done, updated this PR as per @andrew's comments here. Thanks.

@omkar-foss
omkar-foss requested review from MoralCode and andrew August 21, 2026 09:02

@andrew andrew left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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>
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
@omkar-foss

Copy link
Copy Markdown
Contributor Author

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?

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.

@omkar-foss
omkar-foss requested a review from andrew August 21, 2026 11:20
@omkar-foss

Copy link
Copy Markdown
Contributor Author

🚢

@omkar-foss
omkar-foss merged commit 8be88c1 into chaoss:main Aug 21, 2026
4 checks passed
@omkar-foss
omkar-foss deleted the update-readme branch August 21, 2026 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

Document numeric scoring in readme with examples Document structure and purpose of detectors in README

3 participants