haskell-streaming / haskell-streaming/streaming-bytestring
Expanding the README?
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 19
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Since I'm new to streaming-bytestring I had to struggle through some of the more abstract type signatures, and combinators relatively recently, and so while it is still not all so obvious that I can no longer explain it to others, I wrote some text that helps me to pin down some of the concepts, and might also be of use to others.
This could perhaps be a prose section at the bottom of one of the modules (after all the function synopses), or could be in the README, if users will know to look on github for a more high-level walk-through. More can be written, but what I have so far is at:
https://github.com/vdukhovni/streaming-bytestring/tree/readme-plus
This could become a pull request if adding to the README is the right path forward...
Contributor guide
No contributing guide indexed for this repository
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
Review the proposed explanatory text on the readme-plus branch, then compare the repository README with the relevant module documentation. Decide whether the walkthrough belongs in the README or after a module's function synopses, and consider the issue complete when the concepts and combinators are documented in the agreed location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100