ordinaryindustries/ReviewKit

Update README to better show off the framework

Aberta

#2 aberto em 1 de out. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Swift (12 forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Métricas do repositório

Stars
 (37 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Melhore o README adicionando emblemas, descrição, guia de início, instruções de contribuição, gráficos e informações de licença.
Pilha de tecnologia
swift
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
95