Setup instructions leave out step
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 502
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
The setup instructions for starting local development is missing a step: https://github.com/mobxjs/mobx-devtools/blob/master/HACKING.md#chrome-extension
Instructions listed:
- run git submodule update --init
- run yarn
- run yarn start:chrome
- Go to chrome://extensions, check "developer mode", and click "Load unpacked extension", and select directory lib/chrome
However, step 4 fails, saying it can't find the "icons/toolbar-chrome.png" file.
To fix, I just needed to copy the "html" and "icons" folders from "src/shells/webextension" into the "lib/chrome" folder. However, it would be good to add this to the readme.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open HACKING.md and read the Chrome Extension setup section, then compare its listed steps with the paths src/shells/webextension and lib/chrome mentioned in the issue. Update the instructions to include the missing setup step, and verify that the documented process makes the extension load successfully from chrome://extensions.
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
- 68/100