haskell-servant/servant

greet.hs needs cleanup

Open

#1.336 aberto em 2 de set. de 2020

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
documentationhelp wantedservant-docs

Métricas do repositório

Stars
 (1.953 stars)
Métricas de merge de PR
 (Mesclagem média 23h 44m) (4 fundiu PRs em 30d)

Description

We currently have a haskell module in README.md and another one in example/greet.hs. I think the two have diverged at some point in the past, but even if they've always been different, there should only be one example, so I suggest:

  • replace the haskell code in README.md with a link to example/greet.hs
  • make sure that example/greet.hs contains all the information from the README.
  • add ci machinery that runs greet.hs and compares the output to greet.md, so the example can't get outdated any more.

Guia do colaborador

Direção de pesquisa
Revise o conteúdo atual de README.md e example/greet.hs para identificar suas diferenças. Examine os arquivos de fluxo de trabalho de CI existentes no repositório para entender como adicionar um novo job que execute greet.hs e compare a saída com greet.md. Siga os três tópicos: atualize o README para vincular a greet.hs, certifique se de que greet.hs esteja completo e adicione a verificação de CI.
Pilha de tecnologia
None
Domain
documentationci cd
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.
1-2 dias
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
MarkdownGitHub ActionsYAML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70