贡献代码¶

本章节需要您具备 git 和 github 的基本知识，会使用 git 版本管理工具，以及熟悉 github 的协作开发流程。

分支模型¶

NextPilot 依托 Github Flow 进行项目迭代，它只有一个长期分支，就是 master，因此用起来非常简单。

第一步：根据需求，从master拉出新分支，不区分功能分支或补丁分支。

第二步：新分支开发完成后，或者需要讨论的时候，就向master发起一个pull request（简称PR）。

第三步：Pull Request既是一个通知，让别人注意到你的请求，又是一种对话机制，大家一起评审和讨论你的代码。对话过程中，你还可以不断提交代码。

第四步：你的Pull Request被接受，合并进master，重新部署后，原来你拉出来的那个分支就被删除。

代码风格¶

nextpilot-flight-control.code-workspace 是 Vscode 工作空间文件，已经配置好以下格式化工具，在保存文件时会自动触发自动格式化：

使用 clang-format 使用 ClangFormat 对 C/C++ 代码进行格式化，仓库根目录的 .clang-format 文件定义了格式化配置选项，相关意义请参考这里。
使用 black 对 python 代码格式化
使用 DavidAnson.vscode-markdownlint 对 markdown 格式化
使用 tamasfe.even-better-toml 对 toml 格式化
使用 redhat.vscode-yaml 对 yaml 格式

如果您 不希望 对某个文件下的代码进行格式化，请在该文件夹下添加一个.clang-format文件，内容如下：

---
Language: Cpp
DisableFormat: true
---

C/C++¶

NextPilot 基于 Google C++ Style Guide （中文翻译）代码样式，但是对以下部分部分微调:

文件扩展名

*.hpp，C++头文件
*.h，C头文件
*.cpp，C++文件
*.c，C代码

文件命名

文件名要全部小写, 可以包含下划线 (_) 或连字符 (-), 依照项目的约定. 如果没有约定, 那么 “_” 更好.

类型命名

类型名称的每个单词首字母均大写, 不包含下划线: MyExcitingClass, MyExcitingEnum.

所有类型命名，包括类, 结构体, 类型定义 (typedef), 枚举, 类型模板参数等均使用相同约定, 即以大写字母开始, 每个单词首字母均大写, 不包含下划线. 例如:

// 类和结构体
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...

// 类型定义
typedef hash_map<UrlTableProperties *, string> PropertiesMap;

// using 别名
using PropertiesMap = hash_map<UrlTableProperties *, string>;

// 枚举
enum UrlTableErrors { ...

Python¶

使用 black 进行自动格式化。

提交规范¶

当我们使用Git提交代码时，都需要填写 Commit Message 提交说明。一份清晰简介规范的 Commit Message 能让后续代码审查、信息查找、版本回退都更加高效可靠，因此有必要约束开发者编写符合规范的提交说明。

NextPilot 提交信息规范，遵循Angular Team Commit Specification,，主要包含以下内容：

type（必填），提交的类别，比如feat，fix等
scope（可选），提交的影响范围
subject（必填），提交的主题，一般50字内
body（可选），提交内容详细说明
footer（可选），提交针对某个 issue 或者 task 的链接
sign off（必须），所谓Sign-Off就是在commit message尾部增加一个作者的信息

<type>(<scope>): <subject>

<body> 提交内容详细说明

<footer> 对应issue或task的链接

<sign-off> 签名

以下是一个标准的 Commit Message：

Commit: 37515b80fa150e1ef315824e63098231d4af4031
Parents: eb15ff286ba204ebf1eb6b79915a8a9b806cf869
Author: latercomer <latercomer@qq.com>
Committer: latercomer <latercomer@qq.com>
Date: Thu Sep 26 2024 15:42:49 GMT+0800 (中国标准时间)

✨feat(mc_att_control): add hover thrust throttle estimator

add hover thrust throttle estimator to mc_att_control, set param MC_HOVER_THROTTL_METHOD select estimator method

https://github.com/nextpilot/nextpilot-flight-control/issues/110

Signed-off-by: latercomer <latercomer@qq.com>