ordinaryindustries/ReviewKit

Update README to better show off the framework

Aperta

#2 aperta il 1 ott 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Swift (12 fork)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Metriche repository

Star
 (37 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Migliora il README aggiungendo badge, descrizione, guida introduttiva, istruzioni per contribuire, grafica e informazioni sulla licenza.
Tech stack
swift
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95