haskell-servant/servant

greet.hs needs cleanup

Open

#1.336 geöffnet am 2. Sept. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (422 Forks)batch import
documentationhelp wantedservant-docs

Repository-Metriken

Stars
 (1.953 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23h 44m) (4 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfe die aktuellen Inhalte von README.md und example/greet.hs, um ihre Unterschiede zu identifizieren. Untersuche vorhandene CI Workflow Dateien im Repository, um zu verstehen, wie ein neuer Job hinzugefügt werden kann, der greet.hs ausführt und die Ausgabe mit greet.md vergleicht. Befolge die drei Aufzählungspunkte: Aktualisiere README, um auf greet.hs zu verlinken, stelle sicher, dass greet.hs vollständig ist, und füge die CI Prüfung hinzu.
Tech Stack
Keine
Domain
documentationci cd
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
MarkdownGitHub ActionsYAML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70