Consider adding a README boilerplate for Typelevel projects

typelevel / typelevel.g8

A typelevel.g8 based on sbt-typelevel

https://typelevel.org/sbt-typelevel/

14 stars 5 forks source link

Consider adding a README boilerplate for Typelevel projects #24

Open DavidGregory084 opened 2 years ago

DavidGregory084 commented 2 years ago

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?

rossabaker commented 2 years ago

CI badges sound great. Maven Central, too, but I don't know what those do before first release. Markdown or HTML comments would be an option. That won't work for Discord, because most projects won't have a channel at creation (editorial: good!), and the channel URI is not predictable.