52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# 贡献指南
|
||
|
||
我们感谢所有开发者提交贡献。随时关注我们,Fork 存储库,报告错误,以及在 GitHub 上提交您的代码。但是,我们希望开发者遵循我们的指南,才能更好的做出贡献。
|
||
|
||
## 报告错误
|
||
|
||
- 任何用户都可以通过 **[GitHub issue tracker](https://github.com/taosdata/TDengine/issues)** 向我们报告错误。请您对所遇到的问题进行**详细描述**,最好提供重现错误的详细步骤。
|
||
- 欢迎提供包含由 Bug 生成的日志文件的附录。
|
||
|
||
## 代码提交规则
|
||
|
||
1. 在提交代码之前,需要**同意贡献者许可协议(CLA)**。点击 [TaosData CLA](https://cla-assistant.io/taosdata/TDengine) 阅读并签署协议。如果您不接受该协议,请停止提交。
|
||
2. 请在 [GitHub issue tracker](https://github.com/taosdata/TDengine/issues) 中解决问题或添加注册功能。
|
||
如果在 [GitHub issue tracker](https://github.com/taosdata/TDengine/issues) 中没有找到相应的问题或功能,请**创建一个新的 issue**。
|
||
将代码提交到我们的存储库时,请创建**包含问题编号的 PR**。
|
||
3. 将TDengine仓库库fork到自己的账户中并创建分支(branch)。
|
||
注意:默认分支`main`不能直接接受PR,请基于开发分支`3.0`创建自己的分支。
|
||
注意:修改文档的分支要以`docs/`为开头,以免进行不必要的测试。
|
||
4. 创建pull request,将自己的分支合并到开发分支`3.0`,我们开发团队将尽快审核。
|
||
|
||
如遇任何问题,请添加官方微信 tdengine1。我们的团队会帮忙解决。
|
||
|
||
## 给贡献者的礼品
|
||
|
||
只要您是为 TDengine 做贡献的开发者,不管是代码贡献、修复 bug 或功能请求,还是文档更改,您都将会获得一份**特别的贡献者纪念品礼物**!
|
||
|
||
<p align="left">
|
||
<img
|
||
src="docs/assets/contributing-cup.jpg"
|
||
alt=""
|
||
width="200"
|
||
/>
|
||
<img
|
||
src="docs/assets/contributing-notebook.jpg"
|
||
alt=""
|
||
width="200"
|
||
/>
|
||
<img
|
||
src="docs/assets/contributing-shirt.jpg"
|
||
alt=""
|
||
width="200"
|
||
/>
|
||
|
||
TDengine 社区致力于让更多的开发者理解和使用它。
|
||
请填写**贡献者提交表**以选择您想收到的礼物。
|
||
|
||
- [贡献者提交表](https://page.ma.scrmtech.com/form/index?pf_uid=27715_2095&id=12100)
|
||
|
||
## 联系我们
|
||
|
||
如果您有什么问题需要解决,或者有什么问题需要解答,可以添加微信:tdengine1。
|