Skip to content

Latest commit

 

History

History
10 lines (8 loc) · 678 Bytes

CONTRIBUTING.md

File metadata and controls

10 lines (8 loc) · 678 Bytes

文档建设指南

为了规范化文档的编写, 达到统一的排版与commit视觉效果, 请遵守下述的规范要求, 否则PR将不会被允许通过

  1. 翻译术语, 对于易造成误解的词标注原文, eg. 上下文(context)
  2. 半角标点符号+空格优先, eg. 逗号为, 而不是
  3. 半角标点没有的符号, 使用全角符号, eg. 句号(), 顿号()等
  4. 每一次分支提交都需要PR, 然后做Code Review
  5. 在得到approval之后才可以被合并main分支, 以此来减少不必要的不合规和错误
  6. commit应当遵守commit规范, 可以参考nbc commit命令所做的规范限定