typelevel / typelevel/log4cats
Better documentation
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 416
- Forks
- 77
- Avg merge
- 6h 25m
- Merged PRs (30d)
- 3
Description
It would be very nice if there was some more documentation all of the logger apis that are available for use as well as some beginner friendly examples with explanation.
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
The issue does not name documentation files, tests, or a specific entry point. Start by locating the existing documentation and inventorying the available logger APIs, then define the required beginner examples and explanations; done means the APIs are covered and the examples are understandable.
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