带着Bug看世界

语义化版本2.0.0，版本格式：`主版本号.次版本号.修订号`，版本号递增规则如下：`主版本号`：当你做了不兼容的 API 修改；`次版本号`：当你做了向下兼容的功能性新增；`修订号`：当你做了向下兼容的问题修正。先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面，作为延伸。

代码质量是程序员工作的核心。关注代码质量有以下几个重要原因：提升代码的可读性；提高可维护性；提高程序可持续性水平，减少错误与BUG；促进团队协作：当代码质量统一、规范一致时，团队成员之间的沟通和协作更加容易，减少了因代码风格不一致而引发的冲突和问题；优化性能。

python代码注释风格有很多，比较主流的有reStructuredText风格numpy风格Google风格。Pydocspython环境自带，支持MarkDown，但功能比较简单；Sphinx非常流行，默认支持reStructuredText风格注释，若要支持MarkDown需要扩展插件支持；MkDocs优势是能够很好的支持MarkDown格式来组织文档，支持Google风格注释;对于熟悉MarkDown语法的人来说，推荐使用MkDocs。

Github提供了免费的Actions执行workflows工作流，在CI/CD场景下可用于跑测试用例、构建、打包、部署/发版等操作。1个project可以配置多个workflow，每个workflow使用一个yaml文件配置；单个workflow可以配置多个jobs；单个job可以配置多个steps；step中定义要执行的环境和命令。

在开源项目的README中，经常会见到一些徽章(Badge)小图标，README中这些小图标，每个徽章都对应的一个URL。需要借助网站 shields 、 coveralls 、GitHub workflows工作流。