haskell-servant/servant

greet.hs needs cleanup

Open

#1 336 ouverte le 2 sept. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Haskell (422 forks)batch import
documentationhelp wantedservant-docs

Métriques du dépôt

Stars
 (1 953 stars)
Métriques de merge PR
 (Merge moyen 23h 44m) (4 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez le contenu actuel de README.md et example/greet.hs pour identifier leurs différences. Étudiez les fichiers de workflow CI existants dans le dépôt pour comprendre comment ajouter une nouvelle tâche qui exécute greet.hs et compare la sortie à greet.md. Suivez les trois points à puces : mettez à jour README pour créer un lien vers greet.hs, assurez vous que greet.hs est complet et ajoutez la vérification CI.
Stack technique
Aucun
Domaine
documentationci cd
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
MarkdownGitHub ActionsYAML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70