atlassian / atlassian/better-ajv-errors
Readme security improvement: Split up `npm` and `yarn` code blocks
- Dominant language
- JavaScript
- Stars
- 245
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the README has
```
$ npm i better-ajv-errors
$ # Or
$ yarn add better-ajv-errors
```
One problem with this is that it doesn't allow the developer to just hit 'copy' and paste it into their terminal. npm has problems with people "typo squatting", so copy/pasting is a safer and more secure option than re-typing by hand. Separate code blocks for each command would let a developer stay safer.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the repository README and find the installation code block containing both npm and yarn commands. Separate the commands into independent code blocks so each can be copied and pasted safely; done means the README presents npm and yarn alternatives without combining them in one block.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100