JoarHansson/space-images-app

Improve documentation

Open

#5 opened on Sep 3, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (2 forks)auto 404
documentationgood first issuehacktoberfest

Repository metrics

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

Description

Add more info on how to use and contribute to the project.

Contributor guide

Research direction
Review the existing README and add sections for usage instructions and contribution guidelines. Look at other open source projects for inspiration on documentation structure.
Tech stack
javascript
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90