貢獻者指南

感謝您協助改進 Cordova！此頁面提供有關如何貢獻 Cordova 的一般指南。如果您在此頁面上找不到任何內容，請隨時聯絡開發郵件列表，或在 Cordova Slack 上提問。

先決條件

在貢獻 Apache Cordova 之前，建議您加入郵件列表並簡單自我介紹。

處理問題

所有 Apache Cordova 元件的問題都記錄在 GitHub 上。回報問題時，請遵循這些指南。

認領問題

如果您發現您想處理的問題，可以要求認領它；請留下評論說明您的意圖，提交者會將其分配給您。如果問題明顯沒有人處理，您可以自行處理 (但請先留言告知受讓人)。

提交程式碼

您可以透過在 Apache Github 鏡像站點 github.com/apache/<repo name> 提交 pull request 來提交程式碼。

建立 Pull Request

在 Github 上建立 pull request 的工作流程通常遵循以下步驟

1. 如果尚未建立問題，請開啟問題 (選用)
2. 建立適當 Cordova 儲存庫的本機 Fork
3. 在您的本機 Fork 中，建立一個專用於您正在處理的問題的分支
4. 將您的提交推送到此分支
5. 壓縮這些提交為單一提交 (請參閱下方有關提交訊息的部分)
6. 在 Cordova 儲存庫上建立 pull request
7. 請求程式碼審查

請在提交至 Github 的任何 pull request 的標題中包含問題 ID。如需更多有關 Git 的幫助，請參閱 Git 文件。

程式碼審查

無論您如何提交程式碼，都應該呼叫審閱者查看並合併您的程式碼。GitHub 會提供建議的審閱者，您可以新增他們，或您可以將 pull request 的連結郵寄至開發郵件列表。

測試您的程式碼

您有責任在提交 pull request 之前測試您的變更並更正任何問題。測試包括驗證新增/觸及的功能，以及執行測試套件以驗證沒有迴歸。

當我們說「執行測試套件」時，這包括

• cordova-mobilespec 中的所有自動化測試
• cordova-mobilespec 中可能受變更影響的手動測試
• JS 語法檢查的 npm test
• 任何特定於平台的單元測試
  • cordova-android：npm run test-build
  • cordova-ios：npm test
  • cordova-js：jake test
  • cordova-plugman：npm test

請在問題中新增評論，說明您對變更所做的測試，以便提交者可以瞭解在合併之前已完成的測試。

新增測試

如果可能，請包含驗證您的變更並捕捉任何未來迴歸的測試。大多數儲存庫都有一個 tests/ 目錄，其中包含該元件的測試。

Git 提交訊息

貢獻時，請在您的提交訊息開頭加上問題 ID (如果有的話) 和相關平台 (如果適用)，然後加上提交的描述。GitHub 上的問題 ID 應加上 GH- 前綴，這樣 GitHub 會自動連結問題和 PR。

GH-2345 android: Improved exec bridge by using strings instead of JSON
GH-3456 all: Fixed plugin loading paths that start with /

強烈建議您詳細描述您的 git 提交，以便其他人理解它。如此一來，您的提交訊息可以包含多行。然而，也強烈建議您的提交訊息的第一行不要超過 50 個字元。這是因為一些位於 git 之上的工具 (例如讓您瀏覽儲存庫的 httpd 應用程式) 假設第一行是 50 個字元或更少的頂層摘要。因此，將會使用這些假設來醒目提示和截斷提交訊息，如果沒有遵守這些假設，看起來會很奇怪。摘要和任何進一步的描述之間也應該有一個空白行。例如，這是一個好的提交訊息

GH-1234 Fixed the whizbang widget

- added more sanity checking in the build script.
- fixed the API to return the correct value in the scenario where there
  aren't any whizbangs present.
- corrected the documentation.

作為項目符號列表的替代方案，您可以在這裡以段落形式放置長文字，每行以 72 個字元換行，並且段落之間有空白行。