使用免費開源軟體時遇到問題該怎麼辦?

LeanCloud 發表於 2022-01-26

很多人在使用開源軟體時,因為「不擅長」提問,給開源作者和自己都帶來了很多困擾,本文結合 LeanCloud 工程師曾分享的「社群發帖規範」為大家分享一些如何提問的小經驗,幫助大家在遇到問題時能夠更快地得到解決。

提問前

在與開源作者聯絡前,我們可以嘗試以下方式:

  • 閱讀開源專案開發文件
  • 在常見問題(FAQ)中尋找答案
  • 嘗試網際網路搜尋關鍵詞尋找解決方法

在遇到問題時我們可以先通過查詢文件嘗試解決。一般來說,開源軟體的作者都會寫一份文件來幫助使用者。在使用開源軟體的過程中,部分問題能夠在文件中找到答案,如果找不到,我們還可以在 Stack Overflow (特別是比較流行的開源軟體)以及這個開源軟體在 github 倉庫的 issue(如果這個開源軟體在 github 有倉庫)中試一試。

在文件內容過多時,還可以嘗試使用搜尋關鍵詞快速找到對應內容。

提問規範

首先我們應該寫一個好的標題,儘量用一句話描述清楚問題,並標明所使用的語言、平臺。

正確示例:

  1. 小程式真機上傳資料時,控制檯儲存中顯示的 Class 表名被壓縮為單個字母。
  2. 配置 download 合法域名時顯示「該域名因違規被禁止設定。」

錯誤標題:

  1. 救命,突然就執行不了了
  2. 這兩天也有人反饋同樣的問題,還是不行的

除了描述清楚問題外,最好還能夠提供一些更加詳細的資訊,這些可以幫助原作者更快定位問題,為你提出解決方案。

  • 仔細清楚地描述問題,包含前因後果
  • 完整的復現程式碼
  • 提供如硬體裝置、作業系統、軟體版本、網路等環境資訊

注意:

在提問涉及程式碼部分時,注意不要使用圖片來展示程式碼,因為沒有人會照著圖片手敲程式碼。

社交禮儀

開源軟體作者通常沒有義務免費幫我們解決問題,所以在尋求幫助時,說明來意,並使用「請」、「謝謝」等禮貌用語,以感謝作者們無償花時間幫助我們,友好禮貌的社交方式也會增加我們得到有用回覆的機會。

最後,希望大家看完這篇內容後都能夠學會如何更好地解決問題,開源專案的使用者和作者之間不是甲方和乙方的關係,碰到問題時更多應該抱著「一起合作來解決這個問題」的心態,共同的輸入,才會出現更多優秀的開源專案。