helpshift/mongrove

Improve README

Aberta

#14 aberto em 21 de jan. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Clojure (8 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (10 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Improve README doc. Things that can be added:

  1. Description and purpose
  2. Getting started guide
  3. Contributing guide
  4. API doc link

Guia do colaborador

Direção de pesquisa
Leia o README atual e adicione seções para Descrição, Guia de início, Guia de contribuição e link da documentação da API.
Pilha de tecnologia
clojure
Domain
backenddatabase
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90