Audit prompt wording - Githubissues

Yelp / detect-secrets

An enterprise friendly way of detecting and preventing secrets in code.

Apache License 2.0

3.59k stars 448 forks source link

Audit prompt wording #738

Closed direvus closed 2 months ago

direvus commented 7 months ago

Please check if the PR fulfills these requirements
[x] Tests for the changes have been added
[x] Docs have been added / updated
[x] All CI checks are green
What kind of change does this PR introduce?

Modifies the wording of the audit prompt, so that it makes sense for false positives as well as genuine detections.

This was initially raised as issue #734

What is the current behavior?

The current audit prompt is confusing for false positives.

What is the new behavior (if this is a feature change)?

The prompt now omits any reference to the detection being a secret (since we don't know whether it is or isn't at this point)

Does this PR introduce a breaking change?

No

Other information:

lorenzodb1 commented 2 months ago

Thank you for your contribution @direvus! I'll go ahead and merge this.