Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Improve Better NPM Audit #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tagadiadmt
Copy link
Contributor

@tagadiadmt tagadiadmt commented Jul 3, 2024

What does this PR do?

  • Implements an enhanced version of better-npm-audit with an emphasis on community-driven features and usability improvements.

Why did you choose this solution?

  • The community needed a more robust and flexible tool for npm audit.

What is the dependency graph of the changes?

  • A new markdown file better_audit.md introduces the documentation and usage instructions.
  • Addition of images within the assets folder to visually demonstrate the features.

How to test/verify?

  • Install globally or locally as specified in the better_audit.md documentation.
  • Use the provided npm script commands to execute audits.

Related ticket url:

Additional Resources:

  • Markdown documentation can be found at ./standards/architecture/better_audit.md.
  • Visual aids for the demo:
    • Demo of table displaying the security report
    • Demo highlighting newly reported exceptions
    • Displaying unused exceptions

Copy link

Hi! I'm generating PR title and description for you and will automatically apply it to your PR. I'll react 🚀 to this comment when done. Just sit back and chill!

When you have new changes to this PR and you want to regenerate the title and PR description, just comment churva!

Let me know if something is not working well, e.g.:

  • Some parts of the title and description weren't preserved when generating title and description
  • Disappearing screenshots or links
  • Etc.

Thanks!

(RIP hatdog)

@symphdevtools symphdevtools changed the title [Feature][Trish] Added better-audit [Feature][Trish] Improved Better NPM Audit Jul 3, 2024
@JHNLWHD JHNLWHD changed the title [Feature][Trish] Improved Better NPM Audit docs: Improve Better NPM Audit Jul 23, 2024
@JHNLWHD JHNLWHD changed the title docs: Improve Better NPM Audit docs: add Improve Better NPM Audit Jul 23, 2024
Copy link
Contributor

@JHNLWHD JHNLWHD left a comment

Choose a reason for hiding this comment

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

@tagadiadmt please link this to the main page

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.

3 participants