-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Hey, I wanted to update the package to include some new icons (or their new names), which I have done in #2
But I found the contributing instructions hard to follow, lots of the info in the template doesn't seem to match this project. I wasn't sure what direction you might want to switch (e.g. eslint vs prettier vs whatever) so I haven't made any changes directly.
The parts I spotted:
- Are the npm/node versions right? I had npm 6.x on my machine and this rewrote the entirety of package-lock.json to use lockfileVersion:1. Switching to the latest (9.x) resolved it, and I didn't dig into exactlly what version is expected.
- In step 3 it says
npmwhere I assume it meansnpm install? - Step 4 doesn't seem relevant at all
- I wasn't clear if the tip was actually wanted?
- Under the PR submission instructions it says to run the tests, but there are no tests.
- It also says to run
npm run lintbut that command doesn't work. It's defined aseslint srcbut needs to be something likeeslint src/**/*.ts. But switching to that just makes eslint complain that there's no config file. - I could run prettier OK with
npx prettier -w srcin case that's useful to include.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation