fix: add Long descriptions and fix stale command name in docs examples#47
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)
…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. |
This comment was marked as spam.
This comment was marked as spam.
…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. |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
MoralCode
left a comment
MoralCode
left a comment
There was a problem hiding this comment.
The contents of this PR look good to me!
|
@GautamKumarOffical in future, please avoid spamming PRs with followups every 2 hours. Asking more times is not likely to get your PR merged faster. If you want to get PRs merged faster, the real secret is to join the community to building trust and talking to the humans behind the project. This will put you in a position to be able to work on tasks that are high priority for the maintainers and likely to be reviewed faster. CHAOSS Slack in the #data-ai-detection-action channel is the place to interact with the other maintainers/contributors to this project if youd like to give it a try |
omkar-foss
left a comment
omkar-foss
left a comment
There was a problem hiding this comment.
Hi, could you please update this PR as per these details? Thanks.
|
Updated with CLI help text as requested in #46. Added Long descriptions to root, scan, and text commands with usage examples. Please re-review. |
Command descriptions are looking fine. But there don't seem to be any usage examples added for scan, text and version right now. Could you please check that? I think once those examples are added, this PR should be ready to merge. |
Adds Long descriptions to root, scan, and text commands providing usage examples and detailed explanations of what each command does. Closes chaoss#46 Signed-off-by: Gautam Kumar <gautamkumarofficial@users.noreply.github.com>
|
Added usage examples for scan, text, and version commands using cobra's Example field. Examples now show in --help output. Please re-review. |
GautamKumarOffical
force-pushed
the
fix/add-cli-help-text
branch
from
3cce067 to
05510bd
Compare
This comment was marked as spam.
This comment was marked as spam.
…e name Signed-off-by: Gautam Kumar <gautamkumarofficial@users.noreply.github.com>
omkar-foss
left a comment
omkar-foss
left a comment
There was a problem hiding this comment.
PR looks fine, merging it.
Just one problem in examples here, disclosure version doesn't have a --format flag right now so if someone tries these examples it'll break. But I'll check this out in a separate issue.
github-project-automation
Bot
moved this from Backlog
to Done
in AI Detection GitHub Action Roadmap
3 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