OpenZeppelin / OpenZeppelin/contracts-wizard
Document properly that yarn classic is required (v1.X)
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 294
- Forks
- 186
- Avg merge
- 6h 46m
- Merged PRs (30d)
- 22
Description
Document in readme.md / contributing.md that yarn classic is required to run the project, as yarn modern fails to run scripts such as yarn prepare, without a clear explanation that the package manager is the issue.
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
Update readme.md and contributing.md to state that Yarn Classic (v1.x) is required to run the project. Explain that Yarn Modern can fail on scripts such as yarn prepare, and consider the documentation complete when contributors can identify the required package manager before setup.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100