haskell-servant/servant

greet.hs needs cleanup

Open

#1,336 创建于 2020年9月2日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Haskell (1,953 star) (422 fork)batch import
documentationhelp wantedservant-docs

描述

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.

贡献者指南

技术栈
无
领域
documentationci cd
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
MarkdownGitHub ActionsYAML
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.