开发约定 - GitHermes/GitClient GitHub Wiki

Commit信息规范

  1. commit信息一律用中文

  2. commit信息格式： 首行简要描述此次commit做出的改动，然后空一行，再进行详细描述

编者加： 如果此次commit是为了解决某个issue中提出的问题，在首行写上[#issue：编号]

  1. 需要在commit信息中写清楚： 为什么要做出这一个改动 如果改动之后的代码仍有被改进的空间，需要交代改动之后的代码还有哪些不足

  2. 不要做： 不要在同一个commit中做出2个毫无关联的改动 不要在一个commit中做出巨大无比的改动。 如果这些巨大的改动可以被拆成多个细小的改动，那么就拆成多个commit

更详细的Commit规范

变量命名规范

  1. 驼峰命名法
  2. 类实例变量附加m前缀，类变量附加s前缀，常量需大写。