daabChingrii/website

Improve Documentation for Setting up the Project

Open

#2 opened on Oct 31, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)TypeScript (4 forks)auto 404
Hacktoberfestdocumentationgood first issuehacktoberfest-accepted

Repository metrics

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

Description

Description: The current README lacks details on how to set up the project locally. Add step-by-step instructions for setting up the project, including prerequisites and installation commands. Expected Outcome: Clear, detailed instructions on how to clone, set up, and run the project.

Contributor guide

Research direction
Review the README and add step by step setup instructions from cloning to running.
Tech stack
typescript
Domain
frontend
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90