Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.03 KB

Contributing.md

File metadata and controls

20 lines (16 loc) · 1.03 KB

贡献代码

非常鼓励开发者为本项目贡献代码,但请遵守如下规则:

  1. 计划修改前请先在issue中询问是否可行,能否被合并到主分支中
  2. 修复bug请确保运行通过所有的单元测试,并将bug的单元测试添加到test目录下
  3. 所有PR请发送到dev分支,master分支永远不会直接接受PR
  4. 所有文档、教程的修改请务必注意保持中英版本一致
  5. 代码中注释的添加与修改请确保使用英文,避免出现编译器编码问题
  6. 确保修改后完整构建过一次本项目,这样可以使得根目录下的合并版zeroerr.hpp文件与源码保持一致
  7. 我们欢迎给特殊环境的使用、第三方库的集成提供扩展功能,请将这些扩展放到extension目录下

小技巧

启用 git pre-commit hook

这个hook会在每次commit前运行,可以用来检查代码风格、运行测试等,最后把构建的zeroerr.hpp文件放到根目录下并一起提交

git config --local core.hooksPath .githooks/