typelevel / typelevel/cats-effect
Scaladoc all the things!
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Most of this can be copied over blindly from master. There are a few though that will take rewriting and/or writing from scratch. Everything should at least have a few lines.
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
Compare the repository's Scaladoc coverage with master and identify the items that need copying, rewriting, or new documentation. Start with the undocumented areas, then ensure every item has at least a few lines of Scaladoc; completion means the project is comprehensively documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100