新手任务 | 提交PR

mysterywolf commented 1 year ago

RT-Thread是一个基于社区的开源实时操作系统。RT-Thread代码的不断迭代和发展离不开社区小伙伴的积极贡献和提交代码。

但是一些社区小伙伴可能由于对RT-Thread代码不了解而导致不知道怎么向RT-Thread仓库提交代码。这里给大家做一个简单介绍。

RT-Thread主仓库就是你目前看到的这个仓库：https://github.com/RT-Thread/rt-thread ，我们主要在github下面维护和合并代码。同时，gitee也有同步镜像源，方便网络不通畅的小伙伴访问：https://gitee.com/rtthread/rt-thread

如果想要提交PR，在网络允许的情况下，尽量向RT-Thread github主仓库提交PR。如果网络条件不允许，也可以向gitee仓库提交PR，在review（检视）没有问题后，我们在将其同步到github下面并合并。

如果你刚开始接触RT-Thread，对RT-Thread代码还没有一个清晰的了解，但是非常想要为RT-Thread贡献代码，不妨尝试一下如下的新手任务。新手任务不会触及到核心代码的修改，你可以放心大胆的去改写，并且在完成新手任务的过程中，你可以充分了解git相关知识、如何提交PR、以及RT-Thread代码风格和PR提交流程等相关基本内容。在提交PR的过程中，也会慢慢深入的去学习RT-Thread.

如果你是新手，请按照以下顺序阅读相关视频、文档资料来学会如何给RT-Thread提交PR，并尝试下面的新手PR任务。

https://www.bilibili.com/video/BV1gr4y1w7yX 该视频教你怎么避免复杂的git命令行，基于图形化git来提交PR
https://github.com/RT-Thread/rt-thread/pull/5890 该PR给出了一个简单的新手PR模板

基本上阅读完上面两个资料，你给RT-Thread提交一个简单的PR就没有什么问题啦，后面的内容其实通过边提交PR就可以边学习到，另外如果有空也可以阅读一下文档中心关于提交PR的内容

扩展阅读 : 小伙伴在论坛的经验贴

mysterywolf commented 1 year ago

任务1 函数注释补充

目前，RT-Thread 内核函数的注释非常详细，例如：https://github.com/RT-Thread/rt-thread/blob/master/src/ipc.c#L308 ，用户在编程时可以不用翻手册，直接找到函数定义，就可以知道这个函数的每个参数是什么含义，可以填哪几个参数，需要注意什么等等。

但是，RT-Thread的组件代码函数注释仍然欠缺与上面内核函数一样的详细注释，欢迎小伙伴参照上面给出的模板，对以下路径（文件夹以及其下属子文件夹）的.c源文件进行增加注释。