kowainik / kowainik/typerep-map
Consider writing README with `markdown-unlit` to make it testable automatically
Open
Nobody has claimed this yet.
docs
- Dominant language
- Haskell
- Stars
- 101
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
It's quite a challenge actually how to do this because we also want to test the output result.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and the proposed use of markdown-unlit. Determine how the README's rendered output could be tested automatically, including what output result must be checked; done means the README and its output have a repeatable test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100