Skip to content

Latest commit

 

History

History
15 lines (15 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

15 lines (15 loc) · 1.02 KB
  1. 所有修改都要发pr,审查后合并到主干
  2. 发pr前检查本次修改的文件:
    • 不要动你不需要涉及到的文件
    • 不要有只是增删空格、空行的非实质性的修改
    • 如果需要对代码格式化,将格式化提交和修改提交分离,单独发一个pr
  3. 所有C/C++代码使用clang-format格式化,项目里已经写好样式的配置文件
  4. C/C++代码的命名遵照下面的规范,.clang-tidy里已经写好相应的检查
  5. 所有cmake代码使用cmake-format格式化
  6. 所有python代码使用black格式化
  7. 没有特殊情况,默认缩进是2个空格,不要用 '\t'
  8. python代码使用4个空格缩进
  9. 所有代码文件的最后以一个空行尾
  10. 空行、行尾中不要有没删干净的空格
  11. 程序的打印信息、注释、git提交信息、文档,全部使用简体中文书写,规范使用中文标点
    • 如果git提交信息在控制台里不方便输入中文,就在vscode的源代码管理里提交,那里能输入中文。