...
| Note |
|---|
|
- 在建立任何 Jira 事例前, 請先檢查一下, 使用相關的關鍵字詞, 確認類似的事例還沒出現過。做法是先使用 Jira 頁面右上角的快速搜尋 (Quick Search), 之後可進一步調整搜尋的資料。舉例來說, 預設會搜尋全部專案, 你應該指定搜尋 OFBiz, ... 等等。
- 假如要提供改進或修正的修補檔案(patch), 先建立一個 Jira 事例(如果之前沒有的話), 然後把修補檔案做成事例的附檔。
- 如果沒有修補檔案, 但發現一個 錯誤, 趕緊建一個 Jira 事例 (如果之前沒有) 儘可能提供相關細節 (包含源碼版本, 和使用環境, 以及重製錯誤的步驟)。如果不清楚如何描述, 請參用下面樣板
- 做了什麼 (包含重製錯誤的步驟)
- 期待發生什麼
- 實際發生什麼 (也包括確切的錯誤訊息, ... 等等)
- 有的話, 提供相關網址
- 如果沒有修補檔案, 但想要做改良或新功能的建議, 請先在開發論壇中討論, 不要直接建 Jira 事例; 在論壇中, 社群可以充份考慮, 討論出共識後再建立一個 Jira 事例, 促進 OFBiz 未來的發展。
- 如果沒有修補檔案, 但計劃要做的話, 想先和社群分享設計細節, 應該使用論壇來討論而不是建立 Jira 事例; 另一方面來說, 你目前沒有時間進行, 但已經決定根據特定設計細節要做修補, 相讓社群先瞭解之後的修補檔案內容, 就可以建立 Jira 事例 (之後會把修補檔案附帶進來)。
小結:
- 錯誤: 任何時候發現新的錯誤, 都請建立一個新的 Jira 事例
- 新功能/改良: 如果有修補檔案, 才建立一個新的 Jira 事例 (或是計畫很快的做出來)
|
| Info |
|---|
|
應該儘可能不用此項功能, 修改後的意見會造成論壇不易讀取和瞭解的困擾, 因為大多數人都透過開發論壇讀取意見 (Jira 事例會轉到開發論壇)。
因此應該儘可能以增加意見取代修改。如果 真的需要 修改意見, 就 必須 置放一個 明顯的前置 (加英文大寫) 在意見之前, 以便於區分原先已有的文字。應該是除了包含成雙 "*" 的加強文字或全部回覆, 要有你的名稱在其中, 以突顯增加的部份。 |
如果是一位經常的貢獻者, 而且可幫助此專案長遠發展的話, 就可能變成一個 專案提交者 (英)。
下面的指南主要是協助貢獻者和提交者與整個社群一同工作 :
| Tip |
|---|
|
- 請依循 寫碼慣例 (英)。 請認真閱讀此份一件。
- 裝妥 OFBIZ Subversion 的 客戶端設置檔案
- 提交者請遵循底下兩個主要準則:
- 規則 #1 提交者要像醫師一樣: 首先不造成傷害. 不論在提交前或提交後, 如果會使得已有功能發生問題, 就不要進行提交。無論是和誰一起開發, 或者有人也許是很多人有機會用到它。
- 規則 #2 提交者要像科學家一樣: 先讀再寫. 剛開始入門, 讀和寫的時間比大約是 20:1, 當成為 OFBiz 專家通曉關於專案內外的大小事, 或許可把比例降到 3:1。
- 和社群討論你要的功能。說說打算實作什麼, 以及打算怎麼做? 如果你是這專案的新手, 會是很重要的事。
- 撰寫清楚, 良好的意見, 以及能被瞭解的程式碼。不要採取捷徑, 特別是對於變數名稱, 和錯誤或警告訊息的處理。使用能被瞭解的資料結構。請牢記, 日後有某個人會和你的程式碼相處, 讓他能好好相處。
- 準備一個修補檔案(patch)時, 儘可能避免在相關變更混入格式的變更 (可能的話, 把格式變更獨立出來): 這樣的話, 審核者會較容易著手處理。
- 準備一個修補檔案(patch)時, 請不要在程式碼加入作者資訊, 你的大名會載明在提交紀錄擋 (這是我們保存相關資訊的地方)
- 程式碼請使用 UI 標籤做國際化
- 從小規模貢獻開始, 以便於審核處理。在過程中, 藉此熟悉這個專案的程式碼風格, 以及 "思考方式"。
- 保持讓修補檔案和貢獻容易被審核與提交。雖然大量的程式碼很讓人感動, 但請維持事務的獨立, 以及修補檔案意圖的清晰。請瞭解到大部份的提交者可花 20 分鐘做些額外的瑣事, 但一次要費個 2 到 4 小時來做審核, 及提交一個巨大的修捕檔案就有些困難 (特別是牽涉到任何低階, 或較為敏感, 或較為複雜的東西, 這都需要投入更多的審核)。
如果修補檔案有點複雜的話, 請提供提交者足夠的資訊以進行測試 - 像是實際進行的步驟, 用來測試
- 如果有網址(URL), 會很有幫助
- 把貢獻放到 JIRA, 不要直接寄給提交者, 這樣每個人都可以審核, 以及提供意見。儘管不是必要的, 但透過這種方式可讓貢獻授權給 Apache 軟體基金會, 並可被追蹤。
- 讓更多社群成員試用你提供的修補檔案。寫到 開發論壇 告知所完成的事情, 請大家來試看看, 並支持這項修補。這有助於提交者審核時, 對修補檔案具備更多的信心 ... 瞭解嘗試要做的目標, 也知曉它不破壞任何東西。
|
未完 ...