Improve docs to indicate how to run for development
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 28
- Forks
- 165
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 2
Description
At the Code and Learn at Node.JS Interactive, we discovered that the README and CONTRIBUTING files for getting this repo up and running need to be fleshed out.
We discovered that:
- In README, we need to include
npx serve outas part of the Development steps - CONTRIBUTING also needs a revamp of these steps
There might be more things too!
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 with the Development steps in README and CONTRIBUTING. Review how the repository is currently run, add the documented npx serve out step where needed, and check that both files give consistent setup guidance. Done means a newcomer can follow the documented development steps without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100