typelevel / typelevel/typelevel.g8
Consider adding a README boilerplate for Typelevel projects
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 14
- Forks
- 7
- Avg merge
- 5d 16h
- Merged PRs (30d)
- 3
Description
There are certain elements that are generally present on all Typelevel READMEs, things like
- Code of Conduct
- Discord link - maybe just as a badge?
- CI badges
Perhaps we could standardise those things a bit in typelevel.g8?
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 in the typelevel.g8 template and compare existing Typelevel README files to identify the recurring Code of Conduct, Discord, and CI badge elements mentioned in the issue. Confirm which elements should be standardized, then verify that the generated README includes the agreed boilerplate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100