Created
September 30, 2019 13:16
-
-
Save RichardLitt/2472bd3db07ec7ec0ac094269355df03 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ### How to be awesome on GitHub | |
| - 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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment