yellowwoods12/Home-s-Magic

Create proper documentation of the project

Open

#1 opened on Dec 4, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)CSS (8 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

As per one's understanding create a proper document with the complete project structure, implementation details, future scope and other points to make the application more usable and understandable for future contributors.

Contributor guide

Research direction
Explore the repository's file structure, review existing code and comments, and identify the main features and components of the application to create comprehensive documentation.
Tech stack
css
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80