rt-thread
rt-thread copied to clipboard
[Feature] PR规范收集List
Describe problem solved by the proposed feature
统一贡献者提交PR时的相关规范性问题
Describe your preferred solution
编写一份RT-Thread PR提交规范文档,具体规范条件如下:
1.规范PR标题内容
- 前缀约束为类似[stm32][drivers]/[kernel]
- PR内容要求针对PR修改的文件来进行总概
2.PR修改文件提交规范
- PR应尽量避免多个特性混杂在一起,应该分开提交
3.PR commit提交规范
- 针对重要日志可以保留,对常规修改commit需要压缩为一个提交
Describe possible alternatives
No response
可以把想法多多进行补充,然后后续交给copilot来进行处理。
BSP篇
bsp提交PR请遵循如下规范:
1.基础bsp
- 确保bsp官方驱动库以及CMSIS库以软件包形式封装
- 确保基础bsp始终保持最小体量(即仅使能一个串口用于Finsh控制台)
- 确保基础bsp在GCC/IAR/MDK/...环境下编译成功(提交截图)
- 确保基础bsp的scons功能正常(scons --dist、menuconfig、scons --target=iar/mdk/eclipse)
- 确保BSP Readme描述中的外设支持符合实际情况
- 新增bsp应在bsp/README.md中更新:https://github.com/RT-Thread/rt-thread/blob/master/bsp/README.md
- ...
2.bsp驱动
- 提交bsp驱动需考虑多系列的兼容性,在不影响其他系列的前提下预留系列扩展支持,可以引用soc_xxx级别的做外设定义区分
- 提交外设驱动应尽量对接RT-Thread驱动框架OPS(起码保证基础ops对接成功)
- ...
拓展支持
3.bsp导入
- 请尽量确保测试导入bsp rt-thread studio能够正常编译(主要关联到bsp目录下的.settings文件内容)
可以参考一下 #9136
或者汪老师可以帮忙总结一下您那部分的意见?这份ISSUE就作为PR规范的意见征集task了,各个模块都可以细化一下(kernel、component、libcpu...),最终征集大家意见生成一份完善的规范表单,然后可以交给AI去自动检查并抛出comment