Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consider adding a README boilerplate for Typelevel projects #24

Open
DavidGregory084 opened this issue Jun 7, 2022 · 1 comment
Open

Consider adding a README boilerplate for Typelevel projects #24

DavidGregory084 opened this issue Jun 7, 2022 · 1 comment

Comments

@DavidGregory084
Copy link
Member

DavidGregory084 commented Jun 7, 2022 •
edited
Loading

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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rossabaker @DavidGregory084