コーヒーブレイク#43。夢の仕事に就くのを妨げる 6 つのプログラミングの間違い。初めてオープンソース ソフトウェアに貢献する方法

夢の仕事に就くのを妨げる 6 つのプログラミングの間違い

出典: Medium プログラマーとしての仕事を見つけるには、Git リポジトリが必要です。これは採用担当者が最初にチェックする項目の 1 つです。リポジトリに良い印象を与えるには、最近変更されたプロジェクトが含まれている必要があります。これまでに書いたコードのすべての行を表示するのではなく、誇りに思うプロジェクトのみを表示してください。これがリポジトリの操作の基本です。遅かれ早かれ、誰かがあなたのコードを見て、あなたが会社に適しているかどうかを確認するだろうということを忘れないでください。これはあなたにとって決定的な瞬間となるでしょう。数分後、採用担当者はあなたを面接に招待するかどうかを決定します。そして、ここには良いニュースと悪いニュースの両方があります。悪いニュースは、単純な間違いが仕事を得るチャンスを損なう可能性があるということです。良いニュースは、人々は通常、コードを深く掘り下げたくないということです。コードとアーキテクチャについての一般的な理解が必要です。したがって、天才である必要はありません。優れたプログラマーであればよいのです。ここでは、初心者が犯しやすい間違いをいくつか紹介します。それらを避ければ、面接の可能性は大幅に高まります。

古いコメント

コメントについてはプログラマによってさまざまな意見があります。それらを愛する人もいれば、嫌う人もいます。コードにコメントを追加する価値があるかどうか、またどのような場合にコメントを追加する必要があるかについて、共通の結論に達することはできません。しかし、全員が一致しているのは、コメントがある場合はコードと一致する必要があるということです。コードを説明するためのコメントが存在します。コードが複雑または不明瞭な場合は、読者がコードを理解できるように支援する必要があります。コードを変更する場合は、コメントも変更する必要があります。これを行わないと、コメントは役に立たなくなります。悪いコメントは、コメントしないよりもはるかに悪いです。さらに悪いことに、コード内でコメントが強調表示されます。最新の IDE では、コメントが読みやすくするために異なる色で強調表示されます。コメントを追加すると、コードに「読んでください」という記号が追加されます。こうすることで、コメントとコードの不一致が簡単に検出されます。コメントは賢明に選択し、コードとともに忘れずに更新してください。そうすれば、彼らはあなたによく仕えるでしょう。

同じユースケースのライブラリと言語の組み合わせ

最初の面接の前に、採用に関する問題を解決する必要がありました。これは単純な Web アプリだったので、コードを書き、いくつかの複雑な質問を Google で検索すると、アプリの準備が整いました。面接中、採用担当者は私に、コード全体で jQuery コードとプレーン JavaScript を混在させた理由を尋ねました。私の答え？「うーん...」 正直に言うと、スタック オーバーフローからいくつかのコード スニペットを貼り付けました。それについてはあまり考えませんでした。コードは機能したので、次に進みます。このエラーは、新しい開発者の間で非常に一般的です。私たちは職場で問題を解決することに集中するあまり、それをどのように解決するかには注意を払っていません。初心者がこの罠にはまらないようにしてください。コードの各行を調べて、なぜそこにコードを配置したのかを確認してください。

コードの繰り返し

Don't Reply Yourself (DRY) はプログラミングの定説です。反復的なコードの抽象化を作成することは、プログラミングの本質です。はい、最初は難しいかもしれません。問題を解決したいときは、可能な限りあらゆる方法で解決します。その後、他のタスクに移ると、繰り返しのコードが残ります。自分自身のルールを作成することで、この習慣を取り除くことができます。機能を改良するたびに、コードをもう一度読んで、変更できることがないかどうかを確認してください。コードの最初のバージョンは通常間違っており、それを改善することができることに注意してください。重複したコードに気づいたら、時間をかけて調べてください。こうすることで、最適な書き換え方法 (ループを使用するか、新しい関数を作成するなど) を見つけることができます。このクリーニングを毎回実行すると、より信頼性が高くエレガントなコードが完成します。

未処理のエラー

常に完璧に動作する有意義なアプリケーションを作成することはほとんど不可能です。データベースにデータを入力する場合でも、API 呼び出しを行う場合でも、エラーが発生します。未処理のエラーは、個々の機能の実行を停止するだけでなく、アプリケーション全体のクラッシュを引き起こす可能性もあります。起こり得るエラーを予測することは、有能なプログラマーの証です。外部データにアクセスしたり、外部データを更新したりする場合は、常に最悪のシナリオに備える必要があります。アプリケーションが扱いにくくならない方法で、潜在的な問題にフラグを立てます。これにより、コードの読者 (そしておそらくあなた) はエラーをすぐに見つけることができます。また、採用担当者に、あなたが一貫したコードを書けることを示すことにもなります。

一貫性の欠如

一貫性は高品質のソフトウェアの特徴です。これにより、コードが読みやすく、保守しやすくなります。統一されたスタイルで作成されたコードは予測しやすく、プログラムのパフォーマンスを評価しやすくなります。より高い抽象レベルでは、一貫性を達成することが困難になります。習得するには何年もかかりますので、できるだけ早くこのテクニックを学び始める必要があります。必ず 1 つの言語のみを使用してタイトルを作成してください。おそらく英語であるはずですが、個人プロジェクトでは、常に同じ言語であれば、どの言語でも変数や関数に名前を付けることができます。一貫性があれば、タブを使用するかスペースを使用するかは関係ありません。スタイルガイドを作成または選択し、常にそれに忠実に従ってください。Prettierなどのツールも使用する必要があります。これは、コードのフォーマットを一貫した方法に保つのに非常に役立ちます。どのようなツールやスタイルを使用する場合でも、一貫して使用してください。たとえ悪いコードを一貫したスタイルで書いたとしても、修正がはるかに簡単であるため、通常は一貫性のない良いコードよりも優れています。

道具に対する誤解

一般的なプロジェクトでは、おそらく外部ライブラリを使用する必要があります。ライブラリはすべてのプロジェクトで使用されるため、多くのプログラマはほぼ自動的にライブラリをインストールします。外部ライブラリは、繰り返し発生する問題を解決する実証済みの方法であるため、優れています。ただし、新しい開発者は、自分が使用しているライブラリを理解できず、あるライブラリを別のライブラリの上に追加したり、既存の機能の一部を再実装したりすることになることがよくあります。プロジェクトにライブラリをインストールするたびに、ドキュメントを読むか、少なくとも閲覧してください。使用できるメソッドとプロパティを確認し、ライブラリで解決すべき問題と、別のツールの使用が必要な問題を確実に理解してください。こうすることで、業務に適したツールを選択し、その選択を説明することができます。

初めてオープンソース ソフトウェアに貢献する方法

出典: Jamestucker.dev 先日、Evan Yu ( Vue.jsの作成者) が取り組んでいる新しいリポジトリについてのツイートを見て、興味を持ちました。私もそれに貢献したいと決意しました！問題は、私はこれまでオープンソース プロジェクトに貢献したことがなく、どこから始めればよいのか分からなかったことです。でも、そんなに難しいことではないですよね？リポジトリに入るとすぐにフリーズしてしまいました。「一体何をしたらいいんだろう？」と私は思いました。私が PR (プル リクエスト、マージ リクエスト) を行うと、おそらくスペシャリストが私のコードをばらばらにするでしょう。開発業界では、私はオープンソースと適切に連携する方法を知らない男として常に知られるでしょう。そして私のキャリアは終わることになる。幸いなことに、私は、他の人のリポジトリへの最初の投稿はできる限り目立たないようにするべきであると著者がアドバイスした記事を読みました (どこだったかは覚えていません)。これは、タイプミスを修正するなどの単純な作業である可能性があります。そして私もそうしました。リポジトリのドキュメントを読み、いくつかのタイプミスを見つけ、PR を開いたところ、なんと、Evan が私の変更を承認してくれました。私は正式に Vue コントリビューターです! これを私のTwitterのプロフィールに入れるべきでしょうか？

「それは素晴らしいけど、どうやって始めればいいの？」

さて、始めましょう。変化をもたらすために実行できる手順を示します。

1. プロジェクトを探す

インスピレーションを得るために、お気に入りのテクノロジーやツールについて考えてみましょう。あなたが JavaScript を使って作業しており、Gatsby を頻繁に使用しているとします。彼らのリポジトリをチェックしてください! 私のリポジトリに貢献することもできます。これが私のフロントエンドプロジェクトのリストです。気に入ったものや便利なものがあれば、ぜひ追加していただければ幸いです。最後に、Awesome First PR Opportunities は、初心者向けのオープンソース プロジェクトの巨大なリポジトリです。22 か国語のプロジェクトがあります。

2. 貢献方法を決定する

プロジェクトをチェックしてください。Readme を読んでください。さまざまなフォルダーとファイルをスキャンします。コードベースの構造を理解します。こうすることで、タイプミスを簡単に見つけて修正することができます。それが完了したら、プロジェクトの「問題」セクションを見てください。そこには、以前に発見されたバグや提案された機能のリストが表示されます。幸いなことに、多くのプロジェクトには初心者向けの問題が含まれています。最初の貢献はできるだけ控えめであるべきだと思いますが、すぐに評価を得たいのであれば、それはあなた次第です。プロジェクトに追加できるものが見つかったら、それをフォークする必要があります。

3. プロジェクトのフォークの作成

フォーク (プロジェクトのフォーク) は、その正確なコピーを独自の Github リポジトリに作成します。

4. プロジェクトをローカルにクローン作成します

次に、プロジェクト URL を使用して、プロジェクトのクローンをローカル フォルダーに作成します。

git clone <project-url>

ここにURLが表示されます。プロジェクトがコンピュータ上にあるので、エディタで開きます。変更に時間がかかると思われる場合は、プロジェクトのコピーを元のプロジェクトと必ず同期して、変更を常に把握できるようにしてください。このための正確な Git コマンドは、ここで見つけることができます。

5. 変更内容に応じて新しいブランチを作成します

変更/修正を行う時期が来ました。変更を有効にする新しいブランチを作成します。

git branch <branch-name>

好きな名前を付けることができますが、私の経験では、元のプロジェクトでブランチに名前を付けるパターンがわかります。この場合、既存のテンプレートに従うことをお勧めします。タイプミスを修正するのに適したブランチ名はpatch/typo-fixです。git checkout <branch-name>を使用してこのブランチに切り替えることができます。今すぐ変更を加えてください。

6. PR (マージリクエスト) を開く

明らかなタイプミスを修正したり、壊れたリンクを更新したりしました。あなたは自分の仕事に誇りを持っています。あなたは、コーディング、消去、そして Netflix の視聴を同時に行うことができる伝説の開発者の 1 人であることを全世界に知ってもらいたいと考えています。git Push -u Origin <branch-name>を使用して、変更をブランチ Github リポジトリにプッシュします 。フォークした Github リポジトリに移動し、PR (プル リクエスト) を開きます。注: これまでにプル リクエストを行ったことがない場合は、Kent Dodds によるこのビデオを見てその方法を学んでください。ブランチがソース リポジトリの master ブランチを指していることを確認してください。これで、PR に詳細を追加する準備ができました。見出しはPRの内容を明確に伝えるようにしてください。説明を追加する: 既存の問題を解決する場合は、必ずその問題へのリンクを含めてください。説明が完了したら、審査のために PR を送信します。PR を承認する権限を持つ人は、数日以内にあなたの申請を審査し、次のいずれかを行う可能性があります。

1. 変更をすぐにマージします。
2. 変更を加えるように求められます。
3. PRを終了させて​​いただきます。

リポジトリ作成者はフルタイムの仕事や他のプロジェクトで忙しい場合があるため、しばらくお待ちください。

できたね！

これであなたもオープンソース プロジェクトの貢献者になりました。どんな感じですか？独自の Node.js 競合他社を構築する準備はできていますか? 簡単な貢献をすることで、将来のオープンソース作業の見通しがそれほど難しくなくなることを願っています。オープンソースの貢献の詳細については、オープンソースガイドを参照してください。