ordinaryindustries/ReviewKit

Update README to better show off the framework

Open

#2 opened on Oct 1, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Swift (12 forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Repository metrics

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

Description

The current README is bare and doesn't demonstrate what the framework is capable of. Update the README to include at least the following:

  • Badges to reflect project status and information
  • A brief description of the framework's use case
  • Getting started describing an overview of how to use the framework
  • Instructions on how to get to the CONTRIBUTING.md to learn how to contribute to the framework
  • Better graphics and images of the framework in action
  • License information

Contributor guide

Research direction
Improve the README by adding badges, description, getting started, contributing instructions, graphics, and license information.
Tech stack
swift
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.
95