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