喝咖啡休息#43。阻礙您獲得夢想工作的 6 個程式錯誤。如何首次為開源軟體做出貢獻

阻礙你獲得夢想工作的 6 個程式錯誤

來源：Medium 要找到程式設計師的工作，您需要有一個 Git 儲存庫。這是招募人員首先會考慮的事情之一。為了讓您的儲存庫給人留下積極的印象，它應該包含最近更改的項目。只展示您引以為傲的項目，而不是您曾經編寫的每一行程式碼。這是使用儲存庫的基礎知識。請記住，遲早有人會查看您的程式碼，看看您是否適合該公司。這對你來說將是一個決定性的時刻。幾分鐘後，招募人員將決定是否邀請您參加面試。這裡有好消息也有壞消息。壞消息是，一個簡單的錯誤就會損害你獲得這份工作的機會。好消息是人們通常不想深入研究程式碼。他們需要對您的程式碼和架構有一個總體了解。所以你不必是天才——你只需要成為一個優秀的程式設計師。以下是新手常犯的一些錯誤。避免它們，你的面試機會將會大大增加。

過時的評論

程式設計師對於註解有不同的看法。有些人喜歡他們，有些人討厭他們。關於是否值得對程式碼進行註釋以及在什麼情況下進行註釋，我們無法得出共同的結論。但每個人都一致同意一件事：如果您有註釋，它們應該與您的程式碼相符。存在註解來解釋程式碼。當您的程式碼複雜或不清楚時，您需要幫助讀者理解它。另外，當你更改程式碼時，你需要更改你的註解。如果您不這樣做，您的評論將不再有用。一個不好的評論比沒有評論更糟糕。更糟的是，程式碼中的註解被突出顯示。現代 IDE 以不同的顏色突出顯示註釋，使其更易於閱讀。透過新增註釋，您將在程式碼中放置一個「讀我」標誌。這樣，註釋和程式碼之間的任何差異都將很容易被發現。明智地選擇您的評論，並記住將它們與您的程式碼一起更新。這樣他們就會很好地為您服務。

具有相同用例的庫和語言的組合

在第一次面試之前，我必須解決一個招募問題。這是一個簡單的網頁應用程序，所以我編寫了一些程式碼，用谷歌搜尋了一些複雜的問題，然後應用程式就準備好了。在面試過程中，招募人員問我為什麼要在整個程式碼中混合使用 jQuery 程式碼和純 JavaScript。我的答案？「嗯…」老實說，我貼了 Stack Overflow 上的一些程式碼片段。我沒有想太多。該代碼有效，所以我繼續前進。這個錯誤在新開發人員中很常見。我們過於專注於解決工作中的問題，卻沒有註意到我們是如何做到的。不要成為落入這個陷阱的新手之一。檢查每一行程式碼並確保您知道為什麼要將其放在那裡。

程式碼重複

不要重複自己（DRY）是一個程式教條。為重複程式碼創建抽像是程式設計的本質。是的，一開始可能會很困難。當你想解決一個問題時，你會以任何可能的方式去做。然後你繼續執行其他任務，重複的程式碼就會留在你身邊。你可以透過為自己制定一套規則來改掉這個習慣。每次改進功能時，請再次閱讀程式碼，看看是否可以做任何更改。請記住，程式碼的第一個版本通常是錯誤的，您可以改進它。當您發現重複的程式碼時，請花時間研究它。這樣您就可以找出重寫它的最佳方法（例如，使用循環或建立新函數）。如果你每次都進行這樣的清理，你最終會得到更可靠和優雅的程式碼​​。

未處理的錯誤

創建任何始終完美運行的有意義的應用程式幾乎是不可能的。無論您是填充資料庫還是進行 API 呼叫，都會發生錯誤。未處理的錯誤不僅會阻止單一函數運行，甚至可能導致整個應用程式崩潰。預測可能出現的錯誤是一個有能力的程式設計師的標誌。每當您存取或更新任何外部資料時，您都需要為最壞的情況做好準備。以不會使應用程式變得笨拙的方式標記潛在問題。這將使程式碼的讀者（也許還有您）能夠快速找到錯誤。它還將向招聘人員表明您可以編寫有凝聚力的程式碼。

缺乏一致性

一致性是高品質軟體的標誌。它使程式碼更易於閱讀和維護。以統一風格建立的程式碼更可預測，並且更容易評估程式的效能。在更高的抽象層次上，一致性是很難實現的。掌握它需要數年時間，因此您需要儘早開始學習這項技術。請記住僅使用一種語言建立標題。它可能應該是英語，但在個人專案中，您可以用任何語言命名變數和函數，只要它始終是相同的語言。如果你保持一致，那麼使用製表符或空格都沒關係。建立或選擇風格指南並始終堅持下去。您還應該使用像Prettier這樣的工具。它確實有助於以一致的方式保持程式碼格式。無論您使用什麼工具和風格，請始終如一地使用它們。即使您以一致的風格編寫了糟糕的程式碼，它通常也比不一致的好程式碼要好，因為它更容易修復。

對工具的誤解

在典型的專案中，您可能必須使用一些外部程式庫。許多程式設計師幾乎會自動安裝庫，因為它們在每個專案中都會使用。外部函式庫很棒，因為它們是解決重複出現問題的行之有效的方法。然而，新開發人員通常不了解他們正在使用哪些庫，最終會在另一個庫之上添加一個庫或重新實現一些現有功能。每次在專案中安裝庫時，請閱讀或至少查看文件。檢查您可以使用的方法和屬性，並確保您了解庫應該解決哪些問題以及需要使用不同的工具。這樣您就可以為工作選擇正確的工具並解釋您的選擇。

如何首次為開源軟體做出貢獻

資料來源：Jamestucker.dev 有一天，我看到 Evan Yu（Vue.js的創建者）發布的一條關於他正在開發的新儲存庫的推文，這引起了我的興趣。我決定我要為此做出貢獻！問題是我以前從未為開源專案做出貢獻，也不知道從哪裡開始。但這不可能那麼困難，對吧？當我進入存儲庫時，我立即愣住了。「我到底該怎麼辦？」我心裡想。如果我提出 PR（拉取請求、合併請求），專家可能會將我的程式碼撕成碎片。在開發界，我永遠被認為是一個不知道如何正確使用開源的人。我的職業生涯也將結束。幸運的是，我讀過一篇文章（我不記得在哪裡），作者建議您對其他人儲存庫的第一次貢獻應該盡可能謹慎。這可能就像糾正拼字錯誤一樣簡單。我也這麼做了。我閱讀了存儲庫文檔，發現了一些拼寫錯誤，打開了 PR，然後你瞧，Evan 批准了我的更改。我正式成為 Vue 貢獻者！也許我應該把這個放在我的 Twitter 簡介中？

“那太好了，但是我該如何開始呢？”

好的，讓我們開始吧：我將向您展示可以採取哪些步驟來發揮作用。

1. 尋找項目

為了獲得靈感，請考慮您最喜歡的技術或工具。假設您使用 JavaScript 並經常使用Gatsby？查看他們的儲存庫！您還可以為我的存儲庫之一做出貢獻。這是我的前端項目的清單。如果您有喜歡或覺得有用的東西，我很樂意您添加它！最後，Awesome First PR Opportunities是一個面向初學者的開源專案的龐大儲存庫。有 22 種不同語言的項目！

2. 決定如何做出貢獻

查看該項目。閱讀自述文件。掃描不同的資料夾和文件。了解程式碼庫的結構。透過這樣做，您可以輕鬆找到並糾正拼寫錯誤！完成此操作後，請查看專案的“問題”部分。在那裡您將找到先前發現的錯誤或建議功能的清單。幸運的是，許多項目都涉及針對初學者的問題。我認為你的第一個貢獻應該盡可能微妙，但如果你想快速獲得認可，這取決於你。一旦找到可以添加到項目中的內容，您將需要分叉它。

3. 建立專案的fork

分叉（專案的分叉）會在您自己的 Github 儲存庫中建立它的精確副本。

4. 將項目克隆到本地

然後使用項目 URL 將項目克隆到本機資料夾。

git clone <project-url>

在這裡您可以找到 URL。現在該項目已位於您的電腦上，請在編輯器中將其開啟。如果您認為更改需要時間，請務必將項目副本與原始項目同步，以便您始終了解更改。您可以在此處找到具體的 Git 命令。

5. 為您的變更建立一個新分支

是時候進行更改/更正了！建立一個新分支，您的變更將在其中生效。

git branch <branch-name>

您可以隨意命名它，但根據我的經驗，您將能夠看到原始專案中命名分支的模式。在這種情況下，我建議遵循現有範本。修復拼字錯誤的一個好的分支名稱是patch/typo-fix。您可以使用git checkout <branch-name>切換到此分支。現在就做出改變吧！

6. 提交 PR（合併請求）

您已經修復了明顯的拼字錯誤或更新了損壞的連結。你對自己的工作感到驕傲。您希望全世界都知道您是神話般的開發人員之一，可以同時編碼、擦除和觀看 Netflix。使用git push -u origin <branch-name>將變更推送到分支 Github 儲存庫 。轉到您分叉的 Github 儲存庫並開啟 PR（拉取請求）。注意：如果您以前從未做過拉取請求，請觀看 Kent Dodds 的這段影片以了解如何操作。確保您的分支指向來源儲存庫的 master 分支。現在您已準備好為您的 PR 添加詳細資訊。確保您的標題清楚地傳達了公關的內容。新增描述：如果您要解決現有問題，請務必包含指向該問題的連結。完成描述後，提交您的 PR 供審核。有權批准 PR 的人可能會在幾天內審核您的申請並執行以下操作之一：

1. 將立即合併變更。
2. 它會要求您進行更改。
3. 將關閉您的 PR。

請耐心等待，因為儲存庫建立者可能正忙於全職工作或其他專案。

你做到了！

您現在是開源專案的貢獻者！感覺如何？準備好建立自己的 Node.js 競爭對手了嗎？我希望透過做出簡單的貢獻，未來開源工作的前景將變得不那麼令人畏懼。有關開源貢獻的更多信息，請查看開源指南。