向Node.js核心貢獻代碼的六個步驟
本文的目的是幫助您完成向 Node.js 核心文件貢獻代碼的***個提交!
向 Node.js 貢獻代碼的方式有很多種。可以參與某個工作組(網站或者聯機診斷工作組等)的工作，可以在 Nodeschools 開設課程提供 Node.js 的教學, 讓那些有著同樣困惑的人可以向你學習。
當然你也可以開始直接向 Node.js 的核心貢獻，比如回答使用者的問題，甚至向項目提交代碼。
接下來，我們介紹提交代碼以獲取樂趣和成就感的必要步驟。
# 1 Fork 項目
請訪問位于 https://github.com/nodejs/node 的 Node.js 官方倉庫，并將該項目 fork 到您的 Github 帳戶。
Contributing to the Node.js Core - Fork
#2 設置 Git 倉庫
擁有了自己的倉庫，就可以直接進入終端使用如下命令克隆項目。
- $ git clone git@github.com:YOUR_USER_NAME/node.git
然后用 cd node命令進入目錄。
注意，你修改 Node.js 的同時，其他人也會同步修改! 因此一定要不定期接受新提交，否則你的倉庫會遺漏代碼。
為了保持你的 fork 是***的， 你必須設置另外一個源去拉取其他人提交的代碼。 為此，在終端中運行以下命令，該命令將設置一個名為upstream的遠程連接。
- $ git remote add upstream https://github.com/nodejs/node.git
建立upstream之后，你可以運行下面的命令，一次獲得所有來自官方 Node.js 倉庫的***提交：
- $ git pull upstream --rebase
- # it will produce an output similar to this one
- remote: Counting objects: 9150, done.
- remote: Compressing objects: 100% (11/11), done.
- remote: Total 9150 (delta 5908), reused 5917 (delta 5908), pack-reused 3231
- Receiving objects: 100% (9150/9150), 6.71 MiB | 2.06 MiB/s, done.
- Resolving deltas: 100% (7343/7343), completed with 3204 local objects.
#3 構建 Node.js 編譯文件
你已經克隆了項目，是時候本地構建編譯 Node.js 文件了!
首先要確認你已經安裝了 GCC 和 Clang(如果你是 Windows 系統可以裝 Visual Studio)環境 , 然后正確安裝 Python 2.6 或 2.7 和 GNU Make。
運行下面的命令，開始構建編譯 Node.js:
- $ ./configure
- $ make -j4
運行 make 帶 -j4 參數將使編譯同時運行 4 個編譯作業，這樣可以顯著減少構建時間。
構建完成后，可以運行如下命令使用你本地構建的 Node.js了：
- $ ./node --version
- v9.0.0-pre
更多關于平臺支持和項目構建的信息可以在這里找到：https://github.com/nodejs/node/blob/master/BUILDING.md
#4 編寫測試用例，運行測試
測試文件應該使用短線串聯的命名方式。
- 測試文件名的***部分應該是以test開始。
- 第二部分是你要測試的模塊信息。
- 第三部分通常是你要測試的方法或者事件的名字。
因此，如果您要為 HTTP 請求編寫一個測試用例，可以把它命名為：test-http-posting-form-data.js。
這是從 Node.js 項目中拿到的示例，看看測試文件長啥樣：
- /*
- In the first line of the test file you should
- enable strict mode, unless you test something
- that needs it disabled
- */
- 'use strict';
- /*
- the common package gives you some commonly
- used testing methods, like mustCall
- */
- const common = require('../common');
- /*
- a small description on what you are testing
- */
- // This test ensures that the http-parser can handle UTF-8 characters
- // in the http header.
- const assert = require('assert');
- const http = require('http');
- /*
- the body of the actual test - tests should exit with code 0 on success
- */
- const server = http.createServer(common.mustCall((req, res) => {
- res.end('ok');
- }));
- server.listen(0, () => {
- http.get({
- port: server.address().port,
- headers: { 'Test': 'Düsseldorf' }
- }, common.mustCall((res) => {
- assert.strictEqual(res.statusCode, 200);
- server.close();
- }));
- });
使用下面的命令來運行測試：
- $ make test
測試內部模塊的小竅門
要測試內部模塊，必須在測試用例中依賴要測試的模塊。問題是，默認情況下 Node.js 不讓你那樣做。解決的方式就是運行 Node.js 時帶上--expose-internals 參數。
編寫測試用例的更多信息可以在這里找到：https://github.com/nodejs/node/blob/master/doc/guides/writing-tests.md
#5 找一些有意義的事做
截至本文撰寫之時，Node.js 項目中有 563 個待解決的問題 。所以剛開始的時候，這些問題就是你要找的可以做的事情，作為新人你可以選擇一個問題來解決。
幸運的是，問題跟蹤器中有幾個標簽可以幫助找到自己中意的***個貢獻。
***個叫做 good first contribution，第二個是 help wanted。首先我建議從 good first contribution 開始挑選一個, 一旦你感覺對項目的工作比較熟悉之后，就可以開始從help wanted 標簽中選擇。
#6 提交解決方案
開發了新功能或擴展了測試覆蓋度之后，只需將更改推送到你的代碼倉庫，然后同步到 Github上。推送，綠色合并按鈕將會出現在頂部。此時只需要新建一個 pull request，并等待其他貢獻者批準/請求你的 pull request 中的更改。
此時，你就成為一個 Node.js 的貢獻者了。 恭喜，請繼續提交!
