Contributing

[TOC]

我们提倡通过提 issue 和 pull request 方式来促进 embedx 的发展。

Issue 提交

请描述清楚使用过程中遇到的问题，提交 issue。

pull request 需要满足代码要求和 commit message 要求。

规范
- C++ 基本使用 Google C++ Style Guide
格式化
- C++ 使用 clang-format 8.0.0 格式化代码，配置文件是".clang-format"
检查
- C++ 使用 clang-tidy 8.0.0 检查代码，配置文件是".clang-tidy"
- C++ 使用 cpplint 检查代码，配置文件是"CPPLINT.cfg"
提交
- C++，在 commit 提交前运行以下命令进行代码检查
```
make -j8 lint
```

commit message 只使用 ASCII 字符且不超过 50 个 ASCII 字符，结尾不加标点符号。

commit message 的格式是。

type: subject
type(scope): subject