haskell-servant/servant

greet.hs needs cleanup

Open

#1336 opened on Sep 2, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
documentationhelp wantedservant-docs

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.

Contributor guide

Tech stack
None
Domain
documentationci cd
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownGitHub ActionsYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the current contents of README.md and example/greet.hs to identify their differences. Examine existing CI workflow files in the repository to understand how to add a new job that runs greet.hs and compares output to greet.md. Follow the three bullet points: update README to link to greet.hs, ensure greet.hs is complete, and add the CI check.