diff --git "a/docs/Contributing to RustSBI/\344\270\272 RustSBI \350\264\241\347\214\256.md" "b/docs/Contributing to RustSBI/\344\270\272 RustSBI \350\264\241\347\214\256.md" new file mode 100644 index 0000000..fd298b4 --- /dev/null +++ "b/docs/Contributing to RustSBI/\344\270\272 RustSBI \350\264\241\347\214\256.md" @@ -0,0 +1,141 @@ +# 为 RustSBI 贡献 + +------------------------------------------ + +## 行为准则 + +采用行为准则制定社区标准，欢迎大家参与贡献。 + +## 提交信息指南 + +一个优秀的*提交*应该只解决一个问题，使得功能完整，即便只有一行代码也可以提交。而一个优秀的*提交信息*是项目的标杆，这是未来其他贡献者给项目贡献的规范。他们会按照你的*提交信息*去编写他们的贡献，从标题的格式到内容的详细程度。所以如何写好一个*提交信息*就显得十分重要。不仅要遵循项目的风格指南，确保*提交信息*的一致；还要使得*提交信息*的标题清晰简洁，能够准确反映变更的内容。 + +需要注意的是，RustSBI 社区采用**全英文**编写的*提交信息*。同时，`rustsbi/rustsbi`若干个模块都具有自己的更改日志文件，我们使用*提交信息*来生成 `CHANGELOG.md` 文档。我们通过*集成测试*检查对本模块文件夹下的任何文件的修改，**必须一并为对应的`CHANGELOG.md`增加 CHANGELOG 条目**。否则检查不通过，可能会导致您的更改无法出现在下一个版本的更新日志中。 + +其次，每个*提交*都需要签名，每次*拉取请求*或*推送*都由*集成测试*检查更新的*提交*是否具有 `Signed-off-by` 标记。 + +### 提交信息格式 + +在标题之后，应提供详细的变更说明。如果你是一个新贡献者，这里推荐可以按照是什么、为什么、怎么做的思路去整理你的*提交信息*。 + +- **是什么**：首先可以描述变更的背景，你所试图解决的是一个什么样的问题。 +- **为什么**：说明变更的影响，与之前进行对比，比如修复了哪些bug、增加了哪些功能或是改善了哪些性能等。 +- **怎么做**：描述你所做出的具体修改。 + +至此，如果你已经清楚地组织了你的*提交信息*或是有了大致思路。那么恭喜你可以进入到下面的格式环节了。 + +一个*提交信息*必须包含标题和脚注，正文部分是可选项。如果你是向项目直接*提交* 的贡献者，那么正文部分则是必要的： + +``` +
+ +[optional ] + +