vedanshjainvj/VedEats

DOCS : Improving README file

Open

#1 opened on Feb 12, 2025

View on GitHubContributor guide
 (4 comments) (1 reaction) (0 assignees)TypeScript (0 forks)auto 404
documentationeasyenhancementgood first issuejwocjwoc-accepted-issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Description:

After setting up the project, make the README file more readable and more understandable to new contributors in setting up the project

Priority: 🔴 High

Steps to Reproduce:

Go to VedEats repository Open README file

Expected Behavior:

A well defined README file

Actual Behavior:

An average README file

Possible Causes:

NA

Screenshots/Videos :

NA

Device & Browser Info:

Browser: (Brave) Device: (Desktop) OS: (Windows)

Additional Context:

NA

Contributor guide

Research direction
Examine the existing README for completeness and clarity. Add sections such as Prerequisites, Installation, Usage, and Contributing. Ensure the setup steps are accurate and easy to follow.
Tech stack
typescript
Domain
full stack
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