[docs]Update the contribution document#11602
Conversation
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
📌 Code Review Assignment🏷️ Tag: documentationReviewers: @CXSforHPU @GorrayLi @lianux-mm Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2026-07-09 17:57 CST)
📝 Review Instructions
|
|
|
||
| 目录名称如果无特殊的需求,请使用全小写的形式;目录名称应能够反映部分的意思,例如各芯片移植由其芯片名称构成或芯片类别构成;components 目录下能够反映组件的意义。 | ||
|
|
||
| BSP 目录应遵循清晰的层级关系,避免把板级、芯片级和架构级代码混放。推荐按 `bsp/<vendor>/<series>/<board>` 或 `bsp/<vendor>/<board>` 组织目录:`board/` 放置板级初始化、引脚、时钟、链接脚本等只属于当前开发板的内容;同一厂商或同一系列 BSP 共用的芯片库、HAL、CMSIS、SDK、驱动和驱动适配代码应放在上层 `libraries/` 目录,驱动目录也应放在 `libraries/` 下;工具脚本放在同级 `tools/` 目录。若多个 BSP 共用同一个软件包或 SDK,不应在每个 BSP 目录下重复维护,应放在共享层级并由 BSP 通过构建脚本引用。 |
There was a problem hiding this comment.
感觉不应该放到代码风格的文档中,而是新开一个md文档,命名为类似“BSP贡献规范”之类的会好一些。
c88f0bb to
c871bbd
Compare
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
你的解决方案是什么 (what is your solution)
请提供验证的bsp和config (provide the config and bsp)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality:
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up