想為開源項目貢獻你的代碼嗎?這裡告訴你該如何入手。
本文以 Emacs 項目為例。
GNU 的項目都通過郵件列表和全世界的貢獻者交流,所以你應該先去 https://lists.gnu.org/mailman/listinfo 找到相應項目的郵件列表。一般建議加入 bug 和 devel 兩個郵件列表。比如 Emacs,找到 Emacs-devel 和 bug-gnu-emacs 郵件列表並訂閱,前者用於討論改進、提新的 feature 等,後者用於反饋 bug、提交 patch。
郵件列表的郵件量一般都比較大,尤其是加入了多個項目的郵件列表後,不僅信息多,還很雜亂,所以建議:
GNU 項目有自己的代碼倉庫,在這裡:https://savannah.gnu.org/ 。
找到 Emacs 的 Git 倉庫:http://git.savannah.gnu.org/cgit/emacs.git
然後把代碼拉回本地:
$ gitclonegit://git.sv.gnu.org/emacs.git -b emacs-25
Emacs 有很多分支,目前的開發主要在 emacs-25 這個分支上進行,所以上面命令我是從 emacs-25 分支上拉取的代碼。
一段時間後維護者會把代碼合並到 master 分支中。
如果之前已經拉過代碼了,在修改前記得 pull 一次來保持代碼是最新的:
$ git pull
不要在當前分支上修改代碼,理由有很多,比如官方不一定接受你的 patch。而是對每修一個 bug 都新建一個分支:
$ git checkout -b tramp-sh-add-doas --track emacs-25
這行命令我新建了一個叫“tramp-sh-add-doas”的分支,取名要有含義,尤其是你在要修復多個 bug 時好區分。這個名字的含義是為了在 tramp-sh 裡增加 doas 命令的支持。
接下來是漫長的編碼階段,主要注意兩點:
代碼寫完後,commit 一下:
$ git commit -a
寫一段好的 commit 也很重要,最簡單的方法就是執行 git log,看別人怎麼寫的。一般 commit 的第一行寫清楚你本次修改是做了什麼,再空一行,逐行列出增加、修改的函數和變量等,讓開發者一目了然,比如:
Author:XiLu<[email protected]>
Date:FriDec1110:52:082015+0200
Initial support forRubyin'etags'
* lib-src/etags.c <Ruby_suffixes>:New variable.
(lang_names):Add an entry forRuby.
(Ruby_functions):Newfunction.(Bug#22116)
提交 commit 後,執行以下命令生成一個 patch 文件:
$ git format-patch emacs-25
這行命令會把當前分支修改的內容和 emacs-25 分支做 diff,然後在當前目錄下生成一個 diff 文件,如:0001-Add-support-for-doas-command.patch。
生成的 patch 文件是需要發到郵件列表裡,相關文件的維護者會跟你溝通並合並到代碼倉庫中的,和 Github 上直接發 Pull Request 來比,就沒那麼幸福了。
最後,把補丁發送到郵件列表去(這裡或許你需要配置一下 Git 的發送郵件,請自行找資料):
git send-email [email protected] 補丁文件1補丁文件2補丁文件..
之後 GNU 的 bug 跟蹤系統會確認你的 bug,並給你提交的 bug 分配一個 ID,然後自動回復一封郵件給你:
然後就等待相關維護者回復郵件與你溝通。在和開發者溝通時就事論事,不要說無關的廢話。另外一定要注意回復郵件的風格,社區一般使用的 Bottom-posting(下回復)風格,實際上很多開源軟件都是用的 Bottom-posting 風格的。如果這方面你不熟悉,請參考維基百科學習一下: https://zh.wikipedia.org/wiki/%E5%9B%9E%E5%B8%96%E9%A3%8E%E6%A0%BC 。QQ 郵箱網頁版是不支持下回復的,最好用郵件客戶端來回復,一般郵件客戶端是可以設置成 Bottom-posting 風格的,請 Google 自行查閱設置方法。
開發者和你進一步溝通,完畢之後會關閉這個 bug,並把代碼合並到倉庫中去。
你的代碼在合並到倉庫之前可能還會有一道障礙,直到清除障礙後代碼才可以進入倉庫——簽協議。
如果你貢獻的代碼超過15行(見:https://www.gnu.org/prep/maintain/html_node/Legally-Significant.html),是需要和 FSF(自由軟件基金會)簽紙質協議的。
簽協議的主要目的是證明代碼由你所寫,沒有侵犯到其他版權,並且版權歸給 FSF。
如果你提交的代碼確實需要簽文件,開發者會郵件回你一個申請表模板,讓你按模板內容填寫一封申請郵件給 FSF 來申請簽協議文件的。
模板內容如下(注:“#”是我自行添加的注解):
----------------------------------------------------------------------
REQUEST: SEND FORM FOR PAST AND FUTURE CHANGES
[Whatis the name of the program orpackage you're contributing to?]
# 你貢獻的項目名稱,比如Emacs。
# 注意一個項目只能簽一份協議,如果你這裡寫多個項目,就需要簽多份協議。
[Did you copy any files or text written by someone else in these changes?
Even if that material is free software, we need to know about it.]
# 解釋你貢獻的代碼裡是否用了其他項目代碼,如果有就列一下。
[Do you have an employer who might have a basis to claim to own
your changes? Do you attend a school which might make such a claim?]
# 是不是以你個人名義來提交代碼的,是的��就寫no。
# 如果是公司名義,好像需要公司和FSF再簽協議,這個流程我不熟悉。
[For the copyright registration, what country are you a citizen of?]
# 一般就寫China。
[What year were you born?]
# 你生日。
[Please write your email address here.]
# 你郵件地址。
[Please write your postal address here.]
# 通信地址,需要寫詳細點。
[Which files have you changed so far, and which new files have you written
so far?]
# 你改變了哪些文件,列出來。
把這封郵件發給 [email protected], 郵件標題是你真實的姓名 ,郵件內容就是上面模板填寫後的內容。
然後 FSF 會審核你的申請,一般需要幾天。審核通過後他們會給你發一封郵件,讓你將附件的 PDF 文件打印下來,然後簽字,簽上你的名字(不要用中文),以及寫好日期(日期的月份需要用英文,不要用數字,如:2015 December 30)。
接下來,把簽完的紙質協議寄到美國去。你可以去淘寶找 DHL 快遞代收,DHL 大概3天就到了,費用大概是¥140~¥160之間。
他們收到你的紙質協議後也會簽字,需要等幾天,具體周期視他們處理情況而定,如果你等了兩周都還沒回你,那麼你可以回郵件問問怎麼回事,比如我的就正好遇到聖誕節放假。
最後,他們會把簽字後的掃描件以 PDF 格式發送到你的郵箱,整個過程算是結束了。
如果你換了工作,也請告知他們,有可能會涉及到協議重簽,比如你到了新公司,給他們提交的代碼不再是個人性質。
Happy Hacking。
Xue Fuqiao、Eli Zaretskii