今回は、Githubで開発を行う際に押さえておきたい各種Tipsについて解説します。
Bitbucketとは仕様が異なる部分を中心に載せていくため、興味を持った方はぜひ最後までご覧ください。
目次
GhitHubとは
GhitHubは、ソフトウェア開発のプラットフォームです。2008年に公開され、1年も経過しない間に爆発的な人気を誇るようになりました。
ソースコードのホスティングが可能なため、ほかのユーザーとソースコードを共有したり、履歴を残しながら作業したりできます。なお、基本利用料は個人、企業問わず無料です。
GitHubで開発を行うメリット
個人から企業まで幅広く利用されているGitHubですが、GitHubで開発を行うと以下のようなメリットが享受できます。
- 開発業務の効率化
- 検索機能
- コミュニティの活発さ
それぞれのメリットについて、順番にチェックしていきましょう。
開発業務の効率化
GitHubで開発を進めるメリットとして、開発業務の効率化が挙げられます。GitHubにはソースコードを共有する機能が備わっているため、管理や全体の整合性が取りやすいです。
そのため、ソースコード変更後にバグが発生しても、履歴をたどれば原因を素早く特定することが可能です。また、作業スペースを分けられるため、同時に複数の作業も行える点も、開発業務の効率化を助けてくれます。
検索機能
GitHubには、ファイルやプロジェクトを検索する機能が備わっています。検索の際は、修飾子や高度検索によって候補の絞り込みが可能です。
そのため、公開されているファイルのなかから、参考に適したソースコードを素早く見つけられます。また、ローカルにダウンロードする必要のない手軽さも魅力です。
コミュニティの活発さ
コミュニティの活発さも、GitHubのメリットです。GitHubには、コミュニティ機能も搭載されています。
コミュニティ機能では、GitHubを使用しているプログラマーに対して、時間や場所を問わず質問や回答を記入できます。そのため、知識の共有によってスキルの育成も効率的に行うことが可能です。
GitHubで開発を行うデメリット
さまざまなメリットが存在するGitHubを用いた開発ですが、もちろんデメリットも存在します。具体的なデメリットは、以下のとおりです。
- 初期設定に時間がかかる
- 教育コストが高い
- 情報漏洩のリスク
それぞれのリスクについて、以下で詳しく解説します。
初期設定に時間がかかる
効果的に運用するにあたって、プロジェクトや案件に合った運用設計が必須です。しかし、GitHubは初期設定やワークフローの設定に、どうしても時間がかかってしまいます。
もちろん、開発の規模が大きくなれば、その分初期設定の時間と手間も大きくなります。
教育コストが高い
GitHubは、開発プラットフォームとして優秀な存在です。しかし、初心者にとって難易度が低いとは言い難く、使いこなすのにどうしても時間がかかってしまいます。
そのため、有識者がいない場合、教育を代行してくれる人を雇う人件費も必要です。
情報漏洩のリスク
オンライン上にソースコードを公開しているため、情報漏洩のリスクが高いです。実際に、2023年には1,200万件を超える認証情報が流出しています。
情報漏洩は企業の売り上げや信頼に関わるため、必ず阻止しなければなりません。なお、ローカル環境で管理している場合は、情報漏洩のリスクはそこまで高くないため、安心してください。
GitHubで開発を始める手順
GitHubを使用した開発は、手順を押さえれば問題なく始められます。以下では、開発の詳しい手順を紹介するため、ぜひ参考にしてください。
1. masterではなくmainへ
最初にリポジトリのmasterをmainに変更します。変更するかは任意ですが、本記事ではmainとして解説を行っていきます。
mainに変更する背景は、こちらを参照してください。
リポジトリを作成した後は下記の画面になると思います。
この中のgit branch -M mainがブランチ名を変更するコマンドになります。
2. merge済みブランチの自動削除
Settingからgeneralへ遷移し、そのうちPull Requests部分の一番下にある、Automatically delete head branchesにチェックを入れます。
手動で消すこともできますが、マージしたブランチを残すメリットがほぼないため、自動で消すのをおすすめします。
3. まだマージしたくない！PRの作り方
PR名に[WIP]と接頭字をつけるのが慣習だと思いますが、GitHubではDraft PR を使いましょう。
画像の通り、Create pull requestボタンの逆三角から選択できます。
Draft PRとすると、灰色のアイコンで表示され、レビューを送れなくなります。
もしDraftにし忘れた場合や、レビューを受けてWIPにしたくなった場合でも、ReviewersからDraftに変更することが可能です。
4. mainブランチの保護
mainブランチに直Pushする事故からの保護や、Githubに慣れていないメンバーのためにも、mainブランチの保護はあった方が安全です。今回は、PRを必須にしたいと思います。
まずは、リポジトリのSettingのRulesからNew branch rulesetを設定します。それから、Ruleset Nameは任意のルール名を定めてください。
それから、TargetからInclude by patternを選択し、mainを追加します。
他にもdevelopやstagingを含める場合は、ここに追加してください。
最後に、Require a pull request before mergingにチェックを入れることで、PRの作成を必須にできます。
その他の設定については、各々で任意に設定してください。
まとめ
以上、GitHubの基礎知識と開発のTipsについて取り上げてきました。
Githubで開発を始めるための準備として、複数の工程をこなさなければなりません。そのため、抜けや漏れが発生しないように注意する必要があります。
今回取り上げた手順を参考に、みなさんも環境設定を頑張ってください！
