haskell-servant/servant

greet.hs needs cleanup

Open

#1336 aperta il 2 set 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Haskell (422 fork)batch import
documentationhelp wantedservant-docs

Metriche repository

Star
 (1953 star)
Metriche merge PR
 (Merge medio 23h 44m) (4 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi i contenuti attuali di README.md e example/greet.hs per identificarne le differenze. Esamina i file del flusso di lavoro CI esistenti nel repository per capire come aggiungere un nuovo job che esegua greet.hs e confronti l'output con greet.md. Segui i tre punti elenco: aggiorna README per collegare a greet.hs, assicurati che greet.hs sia completo e aggiungi il controllo CI.
Tech stack
Nessuno
Dominio
documentationci cd
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
MarkdownGitHub ActionsYAML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70