学校里的程序设计课程只教如何使用编程语言，网上的大多数项目开发教程只教如何开发一个项目。只有在项目开发中才会知道某些潜规则开发项目的好习惯，如合适地使用 Git 分支管理、版本号命名规则等。

# 合适地使用 Git 分支管理

https://zhuanlan.zhihu.com/p/39148914

Git 基础教程推荐廖雪峰：https://www.liaoxuefeng.com/wiki/896043488029600

# 版本号命名：语义化版本 (Sematic Version)

https://semver.org/lang/zh-CN/

# Git commit 规范：语义化提交信息 (Semantic Commit Messages)

https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716

使用以下风格编写提交信息：

type(scope): subject

其中 type 为提交类型，推荐从以下 7 个中选择一个：

  • feat: 新功能 (new feature for the user, not a new feature for build script)
  • fix: 修复 bug (bug fix for the user, not a fix to a build script)
  • docs: 文档 (changes to the documentation)
  • style: 修改风格，生产环境代码没有更改 (formatting, missing semi colons, etc; no production code change)
  • refactor: 重构生产环境的代码 (refactoring production code, eg. renaming a variable)
  • test: 增加或重构测试，生产环境代码没有更改 (adding missing tests, refactoring tests; no production code change)
  • chore: 其他琐事，如构建过程或辅助工具的变动，生产环境代码没有更改 (updating grunt tasks etc; no production code change)

三个 commit 信息的例子：

docs: 更新文档

feat(user): 添加用户注册功能

test(user): 添加用户单元测试

# Badge 生成器

这里有通用的 Badge 生成器：

https://img.shields.io/badge/<first>-<last>-<color>.svg
https://img.shields.io/badge/Language-Python%203.9-yellow.svg

Language

# All Contributers

这是 Contributers 生成器。

中文介绍：https://allcontributors.org/docs/zh-cn/bot/overview