streamich/git-cz

Docs cleanup

Aberta

#121 aberto em 16 de jan. de 2020

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)JavaScript (111 forks)github user discovery
good first issuehelp wanted📓 documentation

Métricas do repositório

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

Description

  • Move most of the contents of README.md into separate files:
    • /docs/Installation.md
    • /docs/Configuration.md
    • add /docs/CLI-options.md
    • /docs/Semantic-commits.md
  • Keep in README.md
    • Screenshot
    • Add more badges
    • Quick-start comand npx git-cz
    • Links to docs in /docs folder

Guia do colaborador

Direção de pesquisa
Crie os arquivos de documentação separados conforme listados na lista de verificação e atualize o README.md para incluir links para eles.
Pilha de tecnologia
javascript
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.
1-3 horas
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
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85