- README best practices:
- Include license summary and link to LICENSE.md file
- Include contributing summary and link to CONTRIBUTING.md file
- Include code of conduct summary (in Contributing section) and link to CoC file
- Pronto
- Allows running tools like linters and checkers
- Only looks at files that have changed
- Can run locally, via GitHub hooks, and GitLab hooks
- Shields.io
- Easily add badges to project README files
- Probably want version, CI (Jenkins) status, maybe coverage