ordinaryindustries/ReviewKit

Update README to better show off the framework

Ouverte

#2 ouverte le 1 oct. 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Swift (12 forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Métriques du dépôt

Stars
 (37 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Améliorez le README en ajoutant des badges, une description, un guide de démarrage, des instructions de contribution, des graphiques et des informations de licence.
Stack technique
swift
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
95