unisonweb/unison

Revamp README

Open

#832 aberto em 1 de out. de 2019

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (304 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (6.624 stars)
Métricas de merge de PR
 (Mesclagem média 10d 2h) (5 fundiu PRs em 30d)

Description

README is kinda out of date and could use a refresh. Let’s use this ticket to discuss ideas for what should go in it. Would someone like to take a crack at proposing an outline?

One thing to keep in mind is that we have both the website and the README, so let’s not duplicate content that’s already on the website. README can certainly point to the website.

Prompted by #831

Guia do colaborador

Direção de pesquisa
Leia os três comentários existentes nesta issue para entender os pontos de discussão. Examine o arquivo README atual no repositório (provavelmente na raiz). Compreenda a separação de responsabilidades entre o README e o site do projeto. Proponha um esboço estruturado para o novo README, observando a discussão e evitando duplicação com o site.
Pilha de tecnologia
None
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with UnisonDocumentation writing skills
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60