jamesplease / jamesplease/redux-resource

Remove quick start from README

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

Nobody has claimed this yet.

documentation :book:
Dominant language
JavaScript
Stars
232
Forks
29
PR merge metrics
No merged PRs in 30d

Description

The README should basically just funnel people to the home page

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.

Research direction

Open the repository README and locate the quick-start content. Remove that content so the README primarily directs readers to the project's home page, then review the rendered README to confirm the quick start is gone and the home-page direction remains.

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
60/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.