ModusCreateOrg / ModusCreateOrg/gimbal

`audit` command conflicts with yarn|npm audit

Open
#162 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
116
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
After onboarding the project, I learned that our instructions suggest we add 'audit' to npm run scripts. Problem is that it conflicts with npm audit and yarn audit and is not good practice.

image

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the onboarding instructions and npm scripts that recommend adding an audit command. Confirm the documented command conflicts with npm and Yarn audit, then update the guidance so the conflict is removed and verify the resulting scripts and instructions.

Written by the indexing model from the issue text.

Assessment

Domain
cli, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.