Skip to content

[docs]Update the contribution document#11602

Merged
Rbb666 merged 1 commit into
RT-Thread:masterfrom
CYFS3:docs
Jul 9, 2026
Merged

[docs]Update the contribution document#11602
Rbb666 merged 1 commit into
RT-Thread:masterfrom
CYFS3:docs

Conversation

@CYFS3

@CYFS3 CYFS3 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to:docs
  • 设置PR number为 \ Set the PR number to:11602
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后,提交将自动更新至 docs 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the docs branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: @CXSforHPU @GorrayLi @lianux-mm

Changed Files (Click to expand)
  • documentation/7.contribution/INDEX.md
  • documentation/7.contribution/bsp_contribution_guide_cn.md
  • documentation/7.contribution/bsp_contribution_guide_en.md
  • documentation/7.contribution/coding_style_cn.md
  • documentation/7.contribution/coding_style_en.md
  • documentation/Doxyfile.1.9.1
  • documentation/Doxyfile.1.9.8

📊 Current Review Status (Last Updated: 2026-07-09 17:57 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@github-actions github-actions Bot added the Doc This PR/issue related with documents label Jul 9, 2026

目录名称如果无特殊的需求,请使用全小写的形式;目录名称应能够反映部分的意思,例如各芯片移植由其芯片名称构成或芯片类别构成;components 目录下能够反映组件的意义。

BSP 目录应遵循清晰的层级关系,避免把板级、芯片级和架构级代码混放。推荐按 `bsp/<vendor>/<series>/<board>` 或 `bsp/<vendor>/<board>` 组织目录:`board/` 放置板级初始化、引脚、时钟、链接脚本等只属于当前开发板的内容;同一厂商或同一系列 BSP 共用的芯片库、HAL、CMSIS、SDK、驱动和驱动适配代码应放在上层 `libraries/` 目录,驱动目录也应放在 `libraries/` 下;工具脚本放在同级 `tools/` 目录。若多个 BSP 共用同一个软件包或 SDK,不应在每个 BSP 目录下重复维护,应放在共享层级并由 BSP 通过构建脚本引用。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

感觉不应该放到代码风格的文档中,而是新开一个md文档,命名为类似“BSP贡献规范”之类的会好一些。

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已修改

@CYFS3 CYFS3 force-pushed the docs branch 3 times, most recently from c88f0bb to c871bbd Compare July 9, 2026 09:49
@Rbb666 Rbb666 merged commit b245c18 into RT-Thread:master Jul 9, 2026
5 checks passed
@CYFS3 CYFS3 deleted the docs branch July 10, 2026 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc This PR/issue related with documents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants