fix: add Long descriptions and fix stale command name in docs examples#47
fix: add Long descriptions and fix stale command name in docs examples#47GautamKumarOffical wants to merge 1 commit into
Conversation
github-project-automation
Bot
moved this to Backlog
in AI Detection GitHub Action Roadmap
GautamKumarOffical
force-pushed
the
fix/add-cli-help-text
branch
from
3627b37 to
c05d0b0
Compare
MoralCode
left a comment
MoralCode
left a comment
There was a problem hiding this comment.
Thanks for the contribution!
Apologies for asking you to fix things that were present in the original code, but i left a comment about how "Ai contribution detection" isnt the most accurate description of this project. Could you update your docs to clarify that we detect the disclosure of AI use, not the actual AI use itself?
Also can you make sure to signoff on your commit? (the contributing.md in chaoss/collectoss has some docs on how to do this if that helps)
| Short: "Detect AI-generated contributions", | ||
| Long: `A standalone CLI tool that detects AI-generated contributions in git |
There was a problem hiding this comment.
detecting ai contributions isnt the most accurate description. this project is intended to detect disclosures of AI contributions. We aren't in the business of detecting AI use when people are trying to hide that they are using AI.
…I use Updated Long descriptions for root, scan, and text commands to clarify that the tool detects signs that AI tool use was disclosed in contributions, not whether AI was actually used. This addresses maintainer feedback on PR chaoss#47. Signed-off-by: Gautam Kumar <gautamkumarofficial@users.noreply.github.com>
|
Hey, updated the docs to clarify we detect disclosure of AI use, not the use itself. Also added signoff to the commit. Let me know if anything else needs changing. |
|
Updated the docs to clarify we detect disclosure of AI use, not the use itself. Also added signoff. Let me know if anything else needs changing. |
…I use Updated Long descriptions for root, scan, and text commands to clarify that the tool detects signs that AI tool use was disclosed in contributions, not whether AI was actually used. This addresses maintainer feedback on PR chaoss#47. Signed-off-by: Gautam Kumar <gautamkumarofficial@users.noreply.github.com>
GautamKumarOffical
force-pushed
the
fix/add-cli-help-text
branch
from
57cd255 to
3cce067
Compare
|
Added Signed-off-by to both commits. Please re-review. |
|
The docs have been updated to clarify that we detect disclosure of AI use, not actual AI use. Signoff is also included. Please re-review. |
|
Updated with signoff and docs clarification. Please re-review when you get a chance. |
2 participants
Fixes #46
Added
Longdescriptions to all four commands so thatdisclosure --helpprovides useful context instead of just the one-linerShorttext.Changes:
scan: added explanation of what it checks (emails, trailers, notes, message patterns)text: added explanation of what it scans and typical use cases (PR descriptions, comments)docs: added brief Long descriptionai-detection-actionreferences in the docs command examples → now correctly saysdisclosure