GroceriStar/groceristar-fetch

Readme is broken

Open

#412 opened on May 24, 2019

View on GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (16 forks)auto 404
bugdocsenhancementgood first issuehelp wantedin-progress

Repository metrics

Stars
 (8 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug The structure is wack. and part of previous readme was important - there i have a list of articles, where i explaining what we're doing here. Before it was more self explanatorry

To Reproduce Just take some time and try to use it. E.g. links at TOC is not accessible. and readme can be longer. should be

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem. image image

image

Additional context Add any other context about the problem here.

Contributor guide

Research direction
Edit the README.md file to fix broken links, improve structure, and restore important content like the list of articles.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90