Skip to content

Commit c1f3e30

Browse files
authored
Merge pull request #116 from whj4674672/master
【完善】代码贡献手册
2 parents 644001e + d0098e9 commit c1f3e30

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

documents/UM5004-RT-Thread ART-Pi 代码贡献手册.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,15 @@
6060
4. 扩展板相关的组件在 libraries 目录下创建相关的文件夹,并放置相关代码 如:libraries/audio 目录下存放 drv_wm8988.c 以及 MP3 解码库
6161
5. 如果项目中使用到了软件包
6262
- 软件包的版本 **必须** 选择为 **release** 版本。如果没有,请联系管理员尽快发布
63-
- 项目工程 README
63+
6. 项目工程 README
6464
- 创建的例程必须详细写明该例程实现的功能
6565
- 写明该例程的操作说明
6666
- 写明该例程的注意事项
6767
- 填写维护人联系信息
68-
6. 参考 RealThread_STMH750-ART-Pi.yaml 文件内信息,修改 yaml 文件,增加新例程的描述信息
69-
7. 开发收尾前,需要手动打包 SDK 生成 ZIP 文件,使用 Studio 导入离线 SDK 的方式检查新建的 project 能正常被创建,能编译通过,能正常下载。保证开发者拿到手的例程是可以做到 **开箱即用**
68+
7. 新建 `docs` 文件夹放在工程目录下 如:`sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_wifi\docs`
69+
- 编写项目 `设计思想.md`。包含项目设计思想,简要的逻辑实现流程图。
70+
8. 参考 RealThread_STMH750-ART-Pi.yaml 文件内信息,修改 yaml 文件,增加新例程的描述信息
71+
9. 开发收尾前,需要手动打包 SDK 生成 ZIP 文件,使用 Studio 导入离线 SDK 的方式检查新建的 project 能正常被创建,能编译通过,能正常下载。保证开发者拿到手的例程是可以做到 **开箱即用**
7072

7173
- 打包成 zip 文件
7274

0 commit comments

Comments
 (0)