mlabs-haskell / mlabs-haskell/lambda-buffers
Document Assumptions for TypeClass System
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 32
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
As Andrea pointed out to me, our typeclass system appears to be sound, but is only sound given a boatload of assumptions. I should write those down somewhere in order that we don't accidentally make a small change and break everything a few months from now.
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
No file, test, or entry point is named. Start by locating the typeclass system implementation and reviewing its soundness assumptions, then document those assumptions where maintainers will find them and verify that the resulting documentation is complete and clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100