1024程序員節,首先向改變世界的程序員致敬!真心祝愿天下的程序員:碼無Bug,少加班,邂逅真愛,多加薪。用技術改變世界的你們,值得更多的美好!
RT-Thread作為一款自主物聯網操作系統,通過開源社區的方式開發,截止目前已有多達上百位程序員在Github上為RT-Thread貢獻代碼,當然還有很多沒有在Github上提交代碼的貢獻者,真誠地感謝您們對RT-Thread付出的心血!
支持RT-Thread的粉絲們請給RT-Thread項目主倉點星星:https://github.com/RT-Thread/rt-thread,以鼓勵RT-Thread的開發者們,也希望有越來越多的RT-Thread貢獻者,為RT-Thread貢獻更多的代碼!
↓↓↓
如果您愿意給RT-Thread貢獻代碼,歡迎通過 GitHub 的 fork 和 pull request 流程來提交代碼。 代碼要求請參考rt_thread項目documentation目錄下coding_style_cn.txt文件(https://github.com/RT-Thread/rt-thread/blob/master/documentation/coding_style_cn.txt)。
以下教程將指導您如何提交代碼,以及如何提交代碼才會被RT-Thread官方認可。。
首先解釋一下pull request這個詞,pull request的意思是推送請求,開發者發起pull request 的目的是請求倉庫維護人采用開發者提交的代碼。下面是摘自知乎 網友的一段解釋:
我嘗試用類比的方法來解釋一下pull reqeust。想想我們中學考試,老師改卷的場景吧。你做的試卷就像倉庫,你的試卷肯定會有很多錯誤,就相當于程序里的bug。老師把你的試卷拿過來,相當于先fork。在你的卷子上做一些修改批注,相當于git commit。最后把改好的試卷給你,相當于發pull request,你拿到試卷重新改正錯誤,相當于merge。
當你想更正別人倉庫里的錯誤時,要按照下面的流程進行:
先 fork 別人的倉庫,相當于拷貝一份別人的資料。因為不能保證你的修改一定是正確的,對項目有利的,所以你不能直接在別人的倉庫里修改,而是要先fork到自己的git倉庫中。
clone到自己的本地分支,做一些bug fix,然后發起pull request給原倉庫,讓原倉庫的管理者看到你提交的修改。
原倉庫的管理者review這個bug,如果是正確的話,就會merge到他自己的項目中。merge的意思就是合并,將你修改的這部分代碼合并到原來的倉庫中添加代碼或者替換掉原來的代碼。至此,整個 pull request 的過程就結束了,原來倉庫中就有了你貢獻的代碼啦。
現在以rt-thread倉庫為例說明貢獻代碼的流程:
1. fork將rt-thread倉庫fork到自己的git倉庫中。
2. 克隆(clone)
將rt-thread倉庫clone到自己的本地PC。
3. 創建本地分支如果想要在rtt項目上做自己的開發,最好創建屬于自己的項目分支,如果是直接對rtt貢獻代碼,那么可以直接在master分支上進行操作。
4. 開發
發現了一個小bug并進行修改。
5. 提交(commit)向本地倉庫提交bug
6. 保持本地倉庫最新
在準備發起 Pull Request 之前,需要同步原倉庫最新的代碼,記得檢查目前的項目是否是最新的版本。
7. Push 到遠程倉庫push到開發者自己的遠程倉庫中。
8. 發起并完成 Pull Request
在git倉庫中選擇自己修改了的分支,點擊create pull request按鈕發起pull request.
9. 提交代碼的一些約定
發起請求成功后,RT-Thread維護人就可以看到你提交的代碼。pull request如果被同意,你的代碼就會被合并到倉庫中。
關于如何有效提交補丁,可以考慮遵循以下的一些事項:
自己的代碼嚴格遵守RT-Thread的代碼規范;RT-Thread是一個干凈,清晰的系統,代碼是給人看的(機器碼才是給機器看的),所以如何寫一份清晰、整潔的代碼也是一門學問。相信能夠合并一個PR,也是對你代碼的提高;
BSP的代碼,請盡量確保代碼改動僅限制于BSP中,而不影響到其他代碼。一上來不管三七二十,大幅修改,而不考慮其他代碼(內核、組件)的感受,被拒絕拒掉,妥妥的!
修改組件的代碼也請盡量限制于本組件以內,天馬行空會被禁空,沒商量的;
提交時,更改說明的message,最好把相關的緣由寫出,并在message標題上增加[BSP]/[組件名]等等的標識。
提交PR后,也多看看一些反饋,這其中可能就包括維護人對代碼的review給出的整改意見,PR掛著不理會反饋,時間長了,也會被拒的。
總而言之,提交代碼,發PR,是讓RT-Thread更棒!也是讓自己的人生有不一樣的色彩!
至此,我們就完成了一次代碼貢獻的過程。
恭喜,你就成為一個RT-Thread 的貢獻者了。請繼續提交代碼!
-
RT-Thread
+關注
關注
31文章
1272瀏覽量
39919 -
GitHub
+關注
關注
3文章
466瀏覽量
16384
原文標題:在Github上為RT-Thread貢獻代碼,為自己的人生涂色(文末有1024節福利)
文章出處:【微信號:RTThread,微信公眾號:RTThread物聯網操作系統】歡迎添加關注!文章轉載請注明出處。
發布評論請先 登錄
相關推薦
評論