Skip to content

ux: soften imperative language in fix commands section header#698

Open
Demiserular wants to merge 2 commits into
OWASP:mainfrom
Demiserular:ux/soften-imperative-language-fix-commands
Open

ux: soften imperative language in fix commands section header#698
Demiserular wants to merge 2 commits into
OWASP:mainfrom
Demiserular:ux/soften-imperative-language-fix-commands

Conversation

@Demiserular

Copy link
Copy Markdown

Replace 'Copy And Run These Fix Commands' with 'Suggested Fix Commands' to present information rather than instruct the user.

Fixes #677

Summary

Softens the imperative language in the fix commands section header from "Copy And Run These Fix Commands" to "Suggested Fix Commands" to present information neutrally rather than instructing the user.

Why this change

The original phrasing "Copy And Run These Fix Commands" uses imperative language that reads as a command directed at the user, which was flagged as jarring. The tool should present information rather than instruct.

What changed

  • Replaced "Copy And Run These Fix Commands" with "Suggested Fix Commands" in printSuggestedFixCommands function (line 83)
  • Replaced "Copy And Run These Fix Commands" with "Suggested Fix Commands" in printCompactOutput function (line 465)

Validation

This is a text-only change with no functional impact. The change was verified by checking both occurrences in src/output/printers.ts were updated correctly.

User-facing impact

Does this change:

  • affect scanning behavior
  • affect output formatting
  • affect JSON output
  • affect docs only

Replace 'Copy And Run These Fix Commands' with 'Suggested Fix Commands'
to present information rather than instruct the user.

Fixes OWASP#677
@Demiserular

Copy link
Copy Markdown
Author

@sonukapoor I think we need to change the output.test.ts for this too pass

@sonukapoor

Copy link
Copy Markdown
Collaborator

@sonukapoor I think we need to change the output.test.ts for this too pass

That is correct. The tests are failing.

@Demiserular

Copy link
Copy Markdown
Author

@sonukapoor I think we need to change the output.test.ts for this too pass

That is correct. The tests are failing.

should I make the change ?

@sonukapoor

Copy link
Copy Markdown
Collaborator

@Demiserular Yes. Please see our contribution guidelines.

https://github.com/OWASP/cve-lite-cli/blob/main/CONTRIBUTING.md#getting-started

Run npm test and npm run build before submitting. PRs with failing tests will not be merged.

@Demiserular

Copy link
Copy Markdown
Author

@sonukapoor kindly check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ux: soften imperative language in fix commands section header

2 participants