Improve docs to indicate how to run for development

Open Beginner friendly
#127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
javascript, node.js
Domain
documentation

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.

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:

  1. In README, we need to include npx serve out as part of the Development steps
  2. CONTRIBUTING also needs a revamp of these steps

There might be more things too!

Dominant language
JavaScript
Stars
29
Forks
165
Avg merge
1d 18h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodejs/learn

All issues in nodejs/learn

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.