README 文件通常用来让人快速了解项目,它应大体包括以下内容:
- 项目背景
- 安装
- 使用
- Badge
- 相关项目(可选)
- 主要项目负责人
- 参与贡献方式
- 开源协议
除了必要的描述外,使用几个漂亮的 Badge(徽章)能让介绍看起来不那么枯燥,而且如果包含几个如 Travis CI
、Coveralls
这样的徽章的话,更能体现自己的代码质量
Travis CI 同 GitHub Actions 一样,都是一种提供持续继承服务的工具,Travis 绑定 GitHub 项目后,每次 push 时都会自动根据配置文件拉取最新代码、构建环境、按照测试模块进行自动测试,这样就能及时发现问题并修复
目前 GitHub 疯狂推荐 GitHub Actions,确实非常好用。还是推荐使用 GitHub Actions,不过顺便拿个 Travis CI 的徽章也不错
Coveralls 可以生成自动测试报告,完成测试覆盖率的统计
以上两种工具都与 GitHub 深度集成,不过略显繁琐,下面介绍一些简单实用又好看并且能够拿过来就用的徽章,主要用到 shields.io,它专门提供简洁、易读的 SVG 格式的徽章,并且支持许多 web 页面和持续集成服务