These are my rough notes from a private event I held today around how to set up your GitHub repository to maximise community contributions and reach. Any thoughts on these would be interesting to me!
- A license file
- Without this, there is no open source
- The license will predicate only the code in that repo, not the rest
- MIT vs GPL vs Apache vs WTFPL
- Updating year and contributors
- A good README
- Standard-readme https://github.com/noffle/art-of-readme
- the-art-of-readme https://github.com/noffle/art-of-readme
- Badges for your chat program
- Outside of GitHub
- CLAs
- Generally not a problem unless you want to change the license
- Don't know of any court case that actually looks at these
- Contributing
- Signals that you care
- Whether or not people can open issues
- Whether or not people can open PRs
- Code patterns: linting, etc
- How to be a Maintainer
- Setting expectations for support
- Code of Conduct
- Diversity is important
- Without it, you will not have a good community
- covgen https://github.com/simonv3/covenant-generator/
- GitHub metadata
- Website field
- Keyword field
- Name of the repository
- Bus-factor
- Org metadata
- Add a profile image
- .github repository
- https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization
- COC
- Contributing
- Funding
- Issue and pr templates
- security
- support
- Monorepo?
- Community repo?
- Bots?
- More guides? https://opensource.guide/starting-a-project/
- How to close issues that you don't like
- Your website portal
- Chat programs
- Twitter? Facebook? LinkedIn?
- Medium vs blog posts
- npm and other package managers