Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[kernel]【示例】如何给RT-Thread提交PR | beautify code #5890

Merged
merged 1 commit into from
Apr 29, 2022

Conversation

mysterywolf
Copy link
Member

@mysterywolf mysterywolf commented Apr 28, 2022

这个PR展示了如何给RT-Thread提交PR (Pull Request, 代码拉取请求)

我的水平可以给RT-Thread提交PR嘛?

完全不用有这个心理负担,不要认为自己的水平不够,开源项目就是一个大家一起来找茬的过程,无论这个“茬”是大是小,对于RT-Thread代码的迭代发展都是很重要的。

提PR一定是要找到RT-Thread的bug才能提?

不一定,就比如这个PR,可以看到,这只是对RT-Thread代码的美化,并没有实质性的修改RT-Thread的任何源码。但是! 这种美化(不限于增加注释,美化代码结构等)对于RT-Thread来说也是非常重要的!因为能够让别人清晰、明了、舒服地阅读代码也是非常重要的!因此不要认为我是小白,我就不能给RT-Thread贡献代码。

我们接收任何对RT-Thread源码迭代发展有益的PR,无论这个PR是大是小,均可!

教程

[1] 请参考视频 从0教你如何给RT-Thread贡献代码
[2] 欢迎 点此论坛文章 加群,群内有人指导你如何提交PR


以下的内容不应该在提交PR时的message修改,修改下述message,PR会被直接关闭。请在提交PR后,浏览器查看PR并对以下检查项逐项check,没问题后逐条在页面上打钩。
The following content must not be changed in the submitted PR message. Otherwise, the PR will be closed immediately. After submitted PR, please use a web browser to visit PR, and check items one by one, and ticked them if no problem.

当前拉取/合并请求的状态 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

@mysterywolf mysterywolf changed the title [kernel] beautify code [kernel]【示例】如何给RT-Thread提交PR | beautify code Apr 28, 2022
@supperthomas supperthomas added the +1 Agree +1 label Apr 28, 2022
@Guozhanxin Guozhanxin added the +2 Agree +2 label Apr 28, 2022
@BernardXiong
Copy link
Member

😵‍💫 这个是要合并吗?

@mysterywolf
Copy link
Member Author

是的 这个合并掉,是配合这个用的 https://club.rt-thread.org/ask/article/e19f1f0f77fbd119.html

@BernardXiong BernardXiong merged commit 62d2403 into RT-Thread:master Apr 29, 2022
@mysterywolf mysterywolf deleted the demo branch April 29, 2022 02:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
+1 Agree +1 +2 Agree +2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants