このガイドでは、GitHub アカウントを設定し、GitHub のコラボレーションとコミュニティに関する機能の概要について説明します。
パート 1: GitHub アカウントの構成
GitHub を初めて使う場合、最初の手順は、アカウントを作成し、ニーズに最適な製品を選び、メール アドレスを検証し、2 要素認証を設定し、プロフィールを表示することです。
GitHub にはいくつかの種類のアカウントがあります。 GitHub を使うすべてのユーザーは自分専用の個人用アカウントを持ち、複数の organization とチームに所属することができます。 個人アカウントは、GitHub.com でのユーザーの ID であり、ユーザーを個人として表すものです。
1. アカウントの作成
アカウントにサインアップするには、https://github.com/ に移動してプロンプトに従います。
GitHub アカウントをセキュリティで保護するには、強力で一意のパスワードを使う必要があります。 詳しくは、「強力なパスワードの作成」をご覧ください。
2.GitHub 製品の選択
個人アカウントのさまざまな機能にアクセスするには、GitHub Free または GitHub Pro を選択できます。 最初にどちらの製品を選べばよいかわからない場合は、後からいつでもアップグレードできます。
GitHub のすべてのプランの詳細については、「GitHub のプラン」を参照してください。
3. メール アドレスの検証
GitHub プランのすべての機能を確実に使用できるように、新しいアカウントにサインアップしたら、メール アドレスを検証します。 詳しくは、「メールアドレスを検証する」をご覧ください。
4. 2 要素認証の構成
2 要素認証 (2FA) は、Web サイトまたはアプリにログインするときに使用されるセキュリティの追加のレイヤーです。 アカウントの安全のため、2FA を構成することを強くお勧めします。 詳しくは、「2 要素認証について」をご覧ください。
必要に応じて、2FA を構成した後、アカウントにパスキーを追加して、セキュリティで保護されたパスワードレス ログインを有効にします。 「パスキーを管理する」を参照してください。
5. GitHub プロフィールとコントリビューション グラフの表示
GitHub プロフィールは、ピン留めしたリポジトリや gist、公開することを選んだ organization メンバーシップ、これまで行ったコントリビューション、作成したプロジェクトを通じて自分の仕事のストーリーを他のユーザーに伝えるものです。 詳細については、「プロフィールについて」および「プロフィールでコントリビューションを表示する」を参照してください。
パート 2: GitHub のツールとプロセスの使用
GitHub を最大限に活用するには、Git を設定する必要があります。 Git は、お使いのコンピューター上でローカルに発生する GitHub 関連のすべての処理を担当します。 GitHub で効果的に共同作業するには、GitHub Flavored Markdown を使って issue と pull request を記述します。
1. Git の学習
GitHub の共同開発アプローチは、他のユーザーが Git を使って表示、フェッチ、更新できるように、ローカル リポジトリから GitHub にコミットを公開することを利用しています。 Git の詳細については、「Git ハンドブック」ガイドを参照してください。 GitHub 上で Git がどのように使われるかの詳細については、「GitHub フロー」を参照してください。
2. Git の設定
Git をローカルのコンピューターで使用する場合は、コマンド ライン、IDE エディター、テキスト エディターのいずれを使用するかにかかわらず、Git をインストールして設定する必要があります。 詳しくは、「Git のセットアップ」をご覧ください。
ビジュアル インターフェイスを使用する場合は、GitHub Desktop をダウンロードして使用できます。 GitHub Desktop は Git にパッケージ化されているため、Git を個別にインストールする必要はありません。 詳しくは、「GitHub Desktop を使ってみる」をご覧ください。
Git をインストールすると、自分のリポジトリであっても、別のユーザーのフォークであっても、ローカル コンピューターから GitHub リポジトリに接続できるようになります。 Git から GitHub.com 上のリポジトリに接続する場合は、HTTPS または SSH を使って GitHub で認証する必要があります。 詳しくは、「リモートリポジトリについて」をご覧ください。
3.GitHub の操作方法の選択
誰もが、GitHub を操作するための独自のワークフローを持っています。使うインターフェイスと方法は、好みや、ニーズに最適なものによって変わります。
GitHub を操作するためのさまざまなアプローチの詳細と、使用できるツールの比較については、「GitHub への接続」を参照してください。
4. GitHub への書き込み
issue と pull request で伝えたいことを明確にし、整理するには、書式設定に GitHub Flavored Markdown を使います。これは、読み書きしやすい構文といくつかのカスタム機能を組み合わせたものです。 詳しくは、「GitHub 上での執筆とフォーマットについて」をご覧ください。
GitHub Flavored Markdown については、GitHub Skills の「Markdown を使用したコミュニケーション」コースで学習できます。
5.GitHub での検索
統合検索機能を使うと、GitHub 上の多くのリポジトリ、ユーザー、コードの行から探しているものを見つけることができます。 検索は GitHub 全体を対象としてグローバルに実行するか、特定のリポジトリや organization に絞って実行することができます。 GitHub で実行できる検索の種類の詳細については、「GitHub での検索について」を参照してください。
検索構文を使用すると、修飾子を使ってクエリを作成し、検索対象を明確に指定できます。 検索で使う検索構文の詳細については、「GitHub 上で検索する」を参照してください。
6.GitHub でのファイルの管理
GitHub を使うと、自分のリポジトリ、または書き込みアクセス権限を持っている任意のリポジトリでファイルを作成、編集、移動、削除できます。 ファイルの変更履歴を行単位で追跡することもできます。 詳しくは、「ファイルを管理する」をご覧ください。
パート 3: GitHub での共同作業
GitHub のリポジトリでは、任意の数のユーザーが共同作業できます。 ユーザーは、設定を構成したり、プロジェクトを作成したり、通知を管理したりして、効果的なコラボレーションを促進できます。
1. リポジトリの操作
リポジトリを作成する
リポジトリは、プロジェクトのフォルダーのようなものです。 個人アカウントには、任意の数のパブリック リポジトリとプライベート リポジトリを含めることができます。 リポジトリには、フォルダーとファイル、画像、ビデオ、スプレッドシート、データ セットのほか、リポジトリ内のすべてのファイルのリビジョン履歴を含めることができます。 詳しくは、「リポジトリについて」をご覧ください。
新しいリポジトリを作成する際には、プロジェクトの概要を紹介する README ファイルと共に、リポジトリを初期化する必要があります。 詳しくは、「新しいリポジトリの作成」をご覧ください。
リポジトリをクローンする
GitHub からローカル コンピューターに既存のリポジトリをクローンできるため、ファイルの追加または削除、マージ競合の修正、複雑なコミットが簡単になります。 リポジトリをクローンすると、その時点で GitHub にあるすべてのリポジトリ データの完全なコピーがプルダウンされます。これには、プロジェクトのすべてのファイルとフォルダーの全バージョンが含まれます。 詳しくは、「リポジトリをクローンする」をご覧ください。
リポジトリをフォークする
フォークは、自分が管理するリポジトリのコピーです。ここで行った変更は、プロジェクト所有者に pull request を送信しない限り、元のリポジトリには影響しません。 一般的にフォークは、他のユーザのプロジェクトへの変更を提案するため、あるいは他のユーザのプロジェクトを自分のアイディアの出発点として活用するために使用します。 詳しくは、「フォークを使って作業する」をご覧ください。
2. プロジェクトのインポート
GitHub に移行したい既存のプロジェクトがある場合は、GitHub Importer、コマンド ライン、または外部移行ツールを使ってプロジェクトをインポートできます。 詳しくは、「ソース コードをインポートする」をご覧ください。
3. コラボレーターとアクセス許可の管理
リポジトリの issue、pull request、および projects を使用して、プロジェクトで他者とコラボレーションできます。 リポジトリ設定の [コラボレーター] タブから、他のユーザーをコラボレーターとしてリポジトリに招待できます。 詳しくは、「コラボレーターを個人リポジトリに招待する」をご覧ください。
ユーザーは、自分の個人アカウントで作成したリポジトリの所有者となり、そのリポジトリを完全に制御できます。 コラボレーターにはリポジトリへの書き込みアクセス権が付与されますが、操作のアクセス許可は制限されます。 詳しくは、「個人アカウントのリポジトリの権限レベル」をご覧ください。
4. リポジトリ設定の管理
リポジトリの所有者は、リポジトリの可視性、トピック、ソーシャル メディア プレビューなど、いくつかの設定を構成できます。 詳しくは、「リポジトリの設定と機能を管理する」をご覧ください。
5. 健全なコントリビューションを促すプロジェクトの設定
リポジトリでのコラボレーターの活動を促進するには、プロジェクトの使用、参加、および啓蒙を促進するコミュニティが必要です。 詳細については、オープンソース ガイドの「友好的なコミュニティを構築する」を参照してください。
所有者は、参加ガイドライン、行動規範、ライセンスなどのファイルをリポジトリに追加することで、コラボレーターが参加しやすい環境を作り、有意義で有用な貢献を促進することができます。 詳しくは、「健全なコントリビューションを促すプロジェクトをセットアップする」をご覧ください。
6. GitHub Issues と Projects
の使用
ユーザーは、GitHub Issues を使用して、問題のある作業を整理し、要求をプルして、Projects を使用してワークフローを管理することができます。 詳細については、「Issueについて」および「Projects について」を参照してください。
7. 通知の管理
通知では、ユーザーがサブスクライブまたは参加している GitHub のアクティビティに関する最新情報が伝えられます。 会話に関心がなくなった場合は、今後受信する通知の種類を、サブスクライブ解除、Watch 解除、またはカスタマイズできます。 詳しくは、「通知について」をご覧ください。
8. GitHub Pages の使用
GitHub Pagesを使用して、自分自身、organization、プロジェクトに関する Web サイトをGitHub.com上のリポジトリから直接ホストできます。 詳しくは、「GitHub Pages について」をご覧ください。
9. GitHub Discussions の使用
リポジトリに対して GitHub Discussions を有効にすると、プロジェクトのコミュニティを構築するのに役立ちます。 保守担当者、共同作成者、閲覧者は、ディスカッションを使用して、お知らせの共有、質問と回答、目標に関する会話への参加を行うことができます。 詳しくは、「ディスカッションについて」をご覧ください。
パート 4: GitHub での作業のカスタマイズと自動化
GitHub Marketplace のツール、GitHub API、既存の GitHub 機能を使用し、作業をカスタマイズしたり、自動化したりできます。
1. GitHub Marketplace
の使用
GitHub Marketplace には、機能を追加し、ワークフローを改善する統合が含まれています。 GitHub Marketplace では、GitHub Apps、OAuth apps、GitHub Actions などの無料および有料のツールを検出、参照、およびインストールできます。
2.GitHub API の使用
GitHub API には REST API と GraphQL API という 2 つのバージョンがあります。 GitHub API を使用し、一般的なタスクを自動化したり、データをバックアップしたり、統合を作成したりできます。 詳しくは、「GitHub の REST API と GraphQL API の比較」をご覧ください。
3. GitHub Actions
の構築
GitHub Actions を利用すると、GitHub で GitHub.com の開発ワークフローを自動化したり、カスタマイズしたりできます。 独自のアクションを作成したり、GitHubコミュニティで共有されたアクションを利用したりカスタマイズしたりできます。 詳しくは、「ワークフローの書き込み」をご覧ください。
4. GitHub Packages
の発行と管理
GitHub Packagesはソフトウェアパッケージのホスティングサービスであり、ソフトウェアパッケージをプライベートもしくはパブリックでホストでき、パッケージをプロジェクト中で依存関係として使えるようになります。 詳しくは、「GitHub Packages の概要」をご覧ください。
パート 5: GitHub での安全な構築
GitHub には、リポジトリ内のコードとシークレットをセキュリティで保護するのに役立つさまざまなセキュリティ機能があります。 一部の機能はすべてのリポジトリで利用できますが、その他の機能はパブリック リポジトリおよび GitHub Advanced Security ライセンスのあるリポジトリでのみ利用できます。 セキュリティ機能の概要については、「GitHub セキュリティ機能」を参照してください。
1. リポジトリの保護
リポジトリ管理者は、リポジトリのセキュリティ設定を構成することで、リポジトリをセキュリティで保護できます。 これには、リポジトリへのアクセスの管理、セキュリティ ポリシーの設定、依存関係の管理が含まれます。 パブリック リポジトリの場合、および GitHub Advanced Security が有効になっている組織が所有するプライベート リポジトリの場合は、コードとシークレットのスキャンを構成して、脆弱性を自動的に特定し、トークンとキーが公開されないようにすることもできます。
リポジトリをセキュリティで保護するために実行できる手順の詳細については、「リポジトリを保護するためのクイック スタート」を参照してください。
2. 依存関係の管理
安全に作業するうえで大きな要素となるのは、プロジェクトの依存関係を維持して、依存するすべてのパッケージとアプリケーションが確実に更新され、セキュリティで保護されるようにすることです。 ユーザーは、リポジトリの依存関係グラフを調べ、Dependabot による pull request の自動生成によって依存関係を最新の状態に維持し、脆弱な依存関係に関する Dependabot アラートとセキュリティ更新プログラムを受信することで、GitHub でのリポジトリの依存関係を管理することができます。
詳しくは、「ソフトウェアサプライチェーンの保護」をご覧ください。
パート 6: GitHub のコミュニティへの参加
GitHub コミュニティにはさまざまな参加方法があります。 オープン ソース プロジェクトに貢献したり、GitHub Community Support の人と交流したり、GitHub Skills で学習したりできます。
1. オープンソース プロジェクトへの貢献
GitHub でオープン ソース プロジェクトに貢献することは、想像しうるあらゆるスキルを習い、教え、築き上げる方法として有益です。 詳しくは、オープンソース ガイドの「オープンソースにコントリビュートする方法」をご覧ください。
GitHub の探索に関するページでは、過去のコントリビューション、星、その他のアクティビティに基づいて、プロジェクトと good first issue に関するパーソナライズされたレコメンデーションを確認できます。詳しくは、「GitHub でオープンソースにコントリビュートする方法を見つける」をご覧ください。
2. GitHub Community Support
とのやり取り
世界中の開発者とつながり、質問をしたり、答えたり、学んだり、GitHub のスタッフと直接やりとりできます。 会話を開始するには、「GitHub Community Support」を参照してください。
3. GitHub Docs
で GitHub について読む
GitHub で使用できる機能が掲載されたドキュメントを読むことができます。 詳しくは、「GitHub Docs のバージョンについて」をご覧ください。
4. GitHub Skills
を使用した学習
GitHub Skills では、自分の GitHub リポジトリでリアルで楽しいプロジェクトを完了することで新しいスキルを習得できます。 各コースは GitHub コミュニティによって作成された実践的なレッスンであり、親切なボットが講師を務めます。
詳しくは、「Git と GitHub の学習リソース」をご覧ください。
5. オープンソース コミュニティのサポート
GitHub Sponsors を使用すると、依存するオープンソース プロジェクトを設計、作成、または保守を行う開発者または Organization に毎月定期的な支払いを行うことができます。 詳しくは、「GitHub スポンサーについて」をご覧ください。
6. GitHub Support
への連絡
GitHub Support は、GitHub を使う際に生じた問題のトラブルシューティングを支援します。 詳しくは、「GitHub Supportについて」をご覧ください。