Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.42 KB

维护 tolangc

贡献代码

  1. 提出 Issue（可选）
  2. 在 Issue 下提出认领该 Issue（可选）
  3. 管理员将 Issue 分配给认领者
  4. 签出分支进行开发
  5. 创建 Pull Request，并关联到该 Issue
  6. 管理员对 Pull Request 进行 Review
  7. 管理员同意 Pull Request，将分支合并到主分支

修改教程

教程位于 docs/tutorials/ 下。教程文件名格式为 <no>-<titile>.md，例如 01-compiler-tutorial-title.md。章节顺序见 README.md 的 Todo 部分。如需在教程中插入图片，请将图片放在 docs/tutorials/imgs/chapter<no>/ 文件夹下。

单元测试

单元测试位于 tests/ 下。尽量为每一个模块编写单元测试，但不对覆盖率进行要求。单元测试文件名格式为 test_<module>.cpp，例如 test_module_name.cpp。

本项目使用 doctest 实现单元测试。doctest 的使用方法见其文档。

编码规范

  • 文件名使用 snake_case，后缀为 .h 和 .cpp。
  • 头文件中使用 #param once 而非 #ifndef。
  • 变量使用 snake_case。
  • 类名使用 PascalCase。
  • 函数和方法使用 snake_case。
  • 私有方法、属性在前面加上一个下划线，如 _private_method、_private_attr。
  • 其他未明确的格式化规范由项目中的 .clang-format 确定。可使用脚本 scripts/format.sh 进行代码格式化。