如何為開源項目提交貢獻

尊重社區(qū)的決定。 你的想法可能會和社區(qū)的優(yōu)先級、愿景等有差異，他們可能對于你的想法提供了反饋和最后決定的理由，這時你應(yīng)該去積極的討論，并尋求妥協(xié)的辦法，維護者必須慎重的考慮你的想法。但是如果你實在是不能同意社區(qū)的做法，你可以堅持下去！繼續(xù)維護自己的分支，或者另起爐灶。

???? “你不能支持我的用例，我很失望，但是你的解釋僅僅是對一小部分用戶起作用，我理解為什么。感謝你的耐心傾聽。”

???? “你為什么不支持我的用例？這是不可接受的！”

最重要的是，保持優(yōu)雅 開源社區(qū)有來自世界各地的協(xié)作者，所以跨語言、文化、地理位置和時區(qū)的情況下會丟失上下文語境。另外，書面交流使得傳達語氣或情緒變得更加困難。對話過程中善意地理解對方的意圖、禮貌地反駁他人的想法，詢問更多的上下文語境，或進一步澄清你的立場都是好事。我們要讓互聯(lián)網(wǎng)變得更加美好。

收集上下文

在正式開始之前，做一些快速的檢查項，以確保沒有人討論過你的想法?？匆槐轫椖康?README、問題（開放的和關(guān)閉的都算）、郵件列表、Stack Overflow。不需去花好幾個小時去全部折騰一遍，但是使用幾個關(guān)鍵的詞匯來搜索一下是必要的。

如果你沒有找到和你想法一樣的內(nèi)容，你就可以繼續(xù)了。如果項目是在 GitHub 上的話，你可以通過開啟一個 issue 或 PR：

• Issues 開啟一次對話或討論
• Pull requests 請求接受自己的解決方法
• 少量的溝通， 諸如澄清或”怎樣做”的問題，嘗試到 Stack Overflow、IRC、Slack 或其它聊天平臺去問。

在你創(chuàng)建 issue 和 PR 之前，請檢查項目的貢獻者文檔（文件名通常叫做 CONTRIBUTING，或者就直接包含在README中），找一些你需要的較具體的東西，例如，他們會要求你遵循某個模版，或者是要求你使用某個測試。

如果你做的是一個非常實際的貢獻，在正式開啟之前，先創(chuàng)建一個 issue。Watch 這個項目是很有幫助的（在 GitHub，點擊 “Watch” ，所有的對話都會通知你），要讓社區(qū)的成員們知道你要做的工作，免得你做了之后，再讓他們知道，他們不同意，就浪費了。

你能夠從單個的項目學(xué)習到 很多 ，只要你踴躍的去使用，在GitHub上密切觀察項目，并閱讀每一個 issue 和 PR。

— @gaearon 參與項目

創(chuàng)建 issue

你應(yīng)該在遇到下列情況下，去創(chuàng)建一個 issue：

• 報告你自己無法解決的錯誤
• 討論一個高級主題或想法(例如. 社區(qū)、遠景、政策等)
• 期望實現(xiàn)某新的特性，或者其它項目的想法

在 issue 的溝通中幾點實用的技巧:

• 如果你剛好看到一個開放的 issue，恰是你打算解決的， 添加評論，告訴他人你將負責這個。這樣的話，可以避免他人重復(fù)勞動。
• 如果說某個 issue 已經(jīng)開放很久了， 這可能是已經(jīng)有人正在解決中，又或者是早已經(jīng)解決過了，所以也請?zhí)砑釉u論，在打算開啟工作之前，最好是確認一下。
• 如果你創(chuàng)建了一個 issue，但是沒多久自己解決了， 也要添加評論，讓其他人知道，然后關(guān)閉該 issue。記錄本身就是為社區(qū)的貢獻。

創(chuàng)建 pull request

在下面的情形時，請你務(wù)必使用PR：

• 提交補丁 (例如，糾正拼寫錯誤、損壞的鏈接、或者是其它較明顯的錯誤）
• 開始一項別人請求的任務(wù)，或者是過去在 issue 中早就討論過的

一個 PR 并不代表著工作已經(jīng)完成。它通常是盡早的開啟一個 PR，是為了其他人可以觀看或者給作者反饋意見。只需要在子標題標記為”WIP”（正在進行中）。作者可以在后面添加很多評論。

如果說項目是托管在 GitHub 上的，以下是我們總結(jié)出的提交 PR 的建議：

• Fork 代碼倉庫 并克隆到本地，在本地的倉庫配置”上游”為遠端倉庫。這樣你可以在提交你的 PR 時保持和”上游”同步，會減少很多解決沖突的時間。(更多關(guān)于同步的說明，請參考這里 .)
• 創(chuàng)建一個分支 用于自己編輯。
• 參考任何相關(guān)的issue 或者在你的 PR 中支持文檔(比如. “Closes #37.”)
• 包含之前和之后的快照 如果你的改動是包含了不同的 HTML/CSS。在你的 PR 中加入相應(yīng)的圖片。
• 測試你的改動！ 若測試用例存在的話，跑一遍，以覆蓋你的更改，若沒有的話，則創(chuàng)建相應(yīng)的用例。無論測試是否存在，一定要確保你的改動不會破壞掉現(xiàn)有的項目。
• 和項目現(xiàn)有的風格保持一致 盡你最大的努力，這也就是意味著在使用縮進、分號、以及注釋很可能和你自己的風格大相徑庭，但是為了節(jié)省維護者的精力，以及未來他人更好的理解和維護，還請你容忍一下。

如果這是你第一次提交 PR?？梢詾g覽 提交 PR 的文檔，這是 @kentcdodds 專門為初次創(chuàng)建 PR 的人寫的公開的資料。