Add better documentation #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mxdvl
added
documentation
jamesgorrie
approved these changes
Oct 30, 2023
|
|
||
| ```sh | ||
| npm install @guardian/package-linter; | ||
| npx package-linter ./package.json; |
There was a problem hiding this comment.
I didn't think you needed to run npm install, rather just npx?
There was a problem hiding this comment.
True, actually! I’m always confused about what npx actually does…
| "@guardian/libs": "^12", | ||
| "@guardian/ab-react": "^2.0.1" | ||
| } | ||
| "name": "npm-dependencies", |
There was a problem hiding this comment.
Suggested change
| "name": "npm-dependencies", | |
| "name": "@guardian/package-linter/fixtures", |
❓
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
Improve the README.
How to test
Ask people what they think. Mainly @jamesgorrie?
How can we measure success?
Adoption!
Have we considered potential risks?
N/A