kentcdodds / kentcdodds/workshop-setup
Extracting the system verification?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 41
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
The system verification logic seems incredibly useful but also infinitely extensible.
I think it would be extremely useful to have a consistent template for implementing these for arbitrary system-level dependencies that takes the different operating systems into account and provides helpful error messages (e.g. pointing out the nodesource repository when a node check on Linux fails or simply pointing users to the official download page for their OS).
Instead of adding these individually to this module (which will require a lot of subjective judgement on whether they should be included in the "core" or not) maybe we can extract a consistent spec/API for them and publish them individually on npm and group them via an ecosystem tag.
Contributor guide
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
Start by reading the existing system verification logic in the module referenced by the issue, then compare how operating-system-specific checks and failure messages are handled. Define the proposed spec/API boundary and npm package grouping before implementation; done means the scope, extensibility model, and user-facing guidance are agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100