GitHub Foundaitons ハンズオン のバックアップ(No.5)

[ トップ ]   [ 新規 | 一覧 | 単語検索 | 最終更新 | ヘルプ ]

• バックアップ一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• GitHub Foundaitons ハンズオン へ行く。
  • 1 (2025-02-21 (金) 17:09:40)
  • 2 (2025-02-21 (金) 19:04:59)
  • 3 (2025-02-21 (金) 23:53:34)
  • 4 (2025-02-22 (土) 18:04:13)
  • 5 (2025-03-05 (水) 16:22:10)
  • 6 (2025-03-05 (水) 18:46:29)
  • 7 (2025-03-05 (水) 23:55:34)
  • 8 (2025-03-06 (木) 14:51:24)
  • 9 (2025-03-06 (木) 17:30:30)
  • 10 (2025-03-06 (木) 18:04:40)
  • 11 (2025-03-14 (金) 14:12:13)

---

「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

• 戻る

目次 †

概要 †

https://github.com/alterbooth/hol-github-foundations/tree/main

詳細 †

共通項 †

Settings †

Template †

• 以下のテンプレートがある。

• エンティティのテンプレート
  • Repository
  • Issue
  • Pull Request

• ドキュメントファイルのテンプレート
  • TOPに表示される優先順は、.github -> root -> docs ディレクトリ

• 複数ファイルを配置する場合の場所（フォルダ名）は、
  エンティティやドキュメントファイル毎に決まっている。

ドメイン1： GitとGitHubの紹介 †

Git and GitHub Basics †

• バージョン管理を説明する
• 分散バージョン管理を定義する
• Git、GitHubの差異を含め説明する
• GitHubリポジトリを説明する
• コミットを説明する
• ブランチを説明する
• Git用語でリモートを定義する
• GitHubフローを説明する

• 機能階層
  Gitを修飾する各種機能が実装されている。

• コード管理・コラボレーション
  • Gitリポジトリ
  • Issue
  • Pull requests
  • Projects
  • Discussions

• 運用支援・開発環境
  • Actions
  • Codespaces
  • Copilot

• セキュリティ
  • Dependabot
  • Code scanning
  • Secret scanning

• 管理
  • Organization
  • Enterprise

• 参考
  • https://dotnetdevelopmentinfrastructure.osscons.jp/index.php?Git
  • https://dotnetdevelopmentinfrastructure.osscons.jp/index.php?Github

GitHub Entities †

• GitHub accounts
  異なるGitHubアカウント（個人、Organization、Enterprise）

• Personal accounts
• Organization accounts
• Enterprise accounts

• GitHubの料金プラン
  • 個人アカウント向けのGitHub製品（Free、Pro）
  • Organizationアカウント向けのGitHub製品（Free、Team）

• GitHub Enterpriseの異なるデプロイメントオプション

• ユーザープロフィールの機能
  メタデータ、実績、プロフィールREADME、リポジトリ、ピン留めされたリポジトリ、スターなど

GitHub Markdown †

• Markdownと、その使用方法
• IssueおよびPull requestコメントなどで使用
• 基本的なフォーマット構文（見出し、リンク、タスクリスト、コメントなど）
• テキストフォーマットツールバーを使用する
• スラッシュコマンドでフォーマット構文を見つける。

GitHub Desktop †

• GitHub Desktopとgithub.comの違い
  • github.com：Gitホスティング・サービス
  • GitHub Desktop：クライアント・ツール

• GitHub Desktopの利用可能な機能
  • GitHub Desktopで開発ワークフローを簡素化
  • クローンしたリポジトリで全てのgit操作を実行

GitHub Mobile †

GitHub Mobileの利用可能な機能

• 素早くIssueやプルリクエストのダッシュボードにアクセス
• 外出先でプルリクエストを承認
• モバイル最適化デザインでGitHubを閲覧し共同作業できる。
• GitHubの様々なエレメント的なものを検索
• GitHubの様々な通知を管理する。

ハンズオン †

https://github.com/alterbooth/hol-github-foundations/tree/main/domain1

• リポジトリの作成
• ローカルにGitクローン
• ローカルで変更（コミット＆プッシュ）
• （VSCodeやCodespacesを使う）
• GitHubから変更を確認
• GitHubから変更（コミット）

ドメイン2：GitHubリポジトリ †

リポジトリのドキュメントファイル †

良いREADMEの構成要素と推奨されるリポジトリファイル

• README.md
  • プロジェクトの概要や使い方を記載するファイル。
  • インストール手順、使い方、サンプルコード、ライセンス情報などが含まれる。

• LICENSE.md
  • ソフトウェアのライセンス情報を記載するファイル。
  • MIT, Apache, GPL などのライセンス条文が記載される。

• CODEOWNERS.md
  • リポジトリ内の特定のファイルやディレクトリに対する責任者（コードオーナー）を定義
  • プルリクエストの自動レビュー割り当てなどに使用される。

• CONTRIBUTING.md
  • プロジェクトへの貢献方法（コントリビューションガイド）を記載するファイル。
  • プルリクエストのルール、コードスタイル、バグ報告の手順などが含まれる。

• CODE_OF_CONDUCT.md
  • プロジェクトの行動規範（Code of Conduct）を定めたファイル。
  • コミュニティ内での適切な行動や禁止事項などを記載する。

• SECURITY.md
  • セキュリティに関するガイドラインや脆弱性の報告方法を記載するファイル。
  • セキュリティリスクや脆弱性の開示ポリシーなどが含まれる。

• SUPPORT.md
  • プロジェクトのサポートに関する情報を記載するファイル。
  • 問い合わせ方法、FAQ、フォーラムやGitHub Issuesの利用方針などが含まれる。

• FUNDING.yml
  • GitHub Sponsors や Open Collective などの資金提供手段を設定
  • プロジェクトの開発支援を希望する場合に記載

• CITATION.cff
  • プロジェクトの引用方法（学術論文向け）を記載するファイル。
  • .cff（Citation File Format）を使用し、研究者が論文などでプロジェクトを正しく引用できるようにする。

基本的なリポジトリのナビゲーション †

• リポジトリの名前
• リポジトリの情報
• リポジトリのREADME表示

• ナビゲーション
  • Code
  • Issues
  • Pull requests
  • Actions
  • Projects
  • Wiki
  • Security
  • Insights
  • Settings
    • General → Template Repository

• Branches
• Commits（履歴）

• コードの取得・展開
  • clone

新しいリポジトリの作成方法 †

• 新しいリポジトリの作成
• 新しいブランチの作成
• リポジトリにファイルを追加
• リポジトリのインサイトを表示
• スターを使ってリポジトリをお気に入り登録

• 機能プレビュー（Feature preview）はプロファイルアイコンから
  • Colorblind themes
  • Command Palette
  • Copilot Workspace for Pull Requests
  • Personal Instructions
  • New Commit Details Page
  • Rich Jupyter Notebook Diffs
  • New Issues Experience
  • New merge experience
  • Enhanced Repos Insights Views
  • Slash Commands

テンプレートリポジトリ †

• テンプレートリポジトリを作成
• 新しいリポジトリの作成

ハンズオン †

https://github.com/alterbooth/hol-github-foundations/blob/main/domain2/README.md

• 機能プレビュー（Feature preview）のNew Issues ExperienceをDisabledにしておく（手順書とUIが変わるので）。

• テンプレートリポジトリを使用してリポジトリを作成
  • ハンズオン１で作成したリポジトリに移動
  • リポジトリのナビゲーションを確認
  • このリポジトリをテンプレートリポジトリとしてマーク
  • テンプレートリポジトリを使用してリポジトリを作成

• 作成したリポジトリを編集する
  • Github上でブランチを作成
  • Github上でファイル（README）を追加
  • Github上でファイル（README）を確認
  • リポジトリにstarを付ける

ドメイン3：共同作業機能 †

Issue、Discussion、Pullrequestの違い

• Issue
  • シンプルなタスクを登録し、管理する。
  • Pull requestsやProjectsと組み合わせ複雑なタスク管理に対応。

• Discussion
  • 議論や質疑応答
  • アイディアやフィードバックの収集
  • Issueに起こす前段階の議論や調査

• Pullrequest
  • Gitのブランチ間の差分から作成
  • 変更内容をレビューするために利用

Issues †

• Issueの作成、IssueからBranchを作成

• Issueを検索およびフィルタリング
  • フィルタによる絞込み、検索
  • プルダウンでフィルタ追加して絞込み、検索

• 基本的なIssue管理

• 割り当て
  • 担当者
  • Label、Milestone、Project
  • Development: Branch、PullRequest?

• ピン留め
• #による各種リンク
• 重複としてマーク（Duplicate of #xx）
• クローズ、再オープン、転送、削除

• Issueキーワード
  • 特定のアクションを自動化
  • Issueやプルリクエストの状態を管理

• Issue TemplateとIssue Form
  • 複数作成できる。
  • 定義ファイルは.github/ISSUE_TEMPLATE/に置く。

• Issue Template
  • Markdownの形式でテンプレートを作成（*.md）
  • ユーザーが自由に編集できる（入力必須項目などの制約なし）

• Issue Form
  • YAMLで記述でテンプレートを作成（*.yml）
  • 構造化されたIssueを作成
  • フォームで必須項目を設定し入力を強制
  • 入力フィールドの種類を指定可能

Pull requests †

• Pull requestの作成
  • Pull requestのタブ
  • ベースブランチと比較ブランチ
  • Issueと比較すると追加でReviewersを指定できる。
  • テンプレートの活用して作成できる。

• Pull requestのステータス
  • Draft（ドラフト）：作業中のPRで、レビューやマージがまだ行われない状態。
  • Open（オープン）：PRが作成され、まだマージやクローズされていない状態。
  • Closed（クローズ）：PRがマージされずに終了した状態。
  • Merged（マージ済み）：PRの変更がメインブランチなどに統合された状態。

• アクティビティをリンク
  • 別のPull Requestを参照
  • Issueを参照
    • キーワードで連動クローズ
    • メタデータのDevelopmentから追加
  • コメントをリンク
  • コミットをリンク
  • コードの特定行をリンク

• ナビゲーション

• Conversation（会話）
  • PRの概要やディスカッションのやりとりが表示されるタブ。
  • レビューコメントやステータス、マージの可否に関する情報を表示

• Commits（コミット）
  • PRに含まれるコミットの一覧が表示されるタブ。
  • それぞれのコミットメッセージや変更履歴を確認

• Checks（チェック）
  • CI/CDのステータスや、自動テストの結果が表示されるタブ。
  • 失敗したチェックの詳細を確認し、修正が必要かどうか判断

• Files changed（変更されたファイル）
  • PRで変更されたファイルの一覧が表示されるタブ。
  • 変更内容を差分表示で確認し、コードレビューを行う

• レビュー関連
  • ファイルのコード行へのリンクにコメント
  • 「Add single comment」or「Start a review - Finish your review」
  • 変更の提案（suggested changes）を提案の確定（commit suggestion）
  • 異なるReview changes（Finish your review）オプション
    • コメント（Comment）
      変更の提案やフィードバックを提供する場合に選択
    • 承認（Approve）
      変更を承認する場合に選択
    • 変更要求
      修正が必要であることを示す場合に選択

• 既定のレビュアーをCODEOWNERSファイルに指定

Discussions †

• Issuesとは異なり、コードに関連しない会話や質問、情報共有を行うための場で2021年8月に正式版となった。
• リポジトリのナビゲーションのSettingsからDiscussionsを有効化、Discussionsタブから「New discussion」or「Start a discussion」

• DiscussionとIssueの違い

• Issue
  • 主にバグの修正、機能の提案、改善のリクエストなど、具体的な作業に関連するものに使用
  • トラッキングに適したフィールド（ラベル、マイルストーン、プロジェクト）により管理を容易にする。

• Discussions
  • 形式にとらわれない広範で自由なコミュニケーション、議論、アイデアの共有に使用
  • チームメンバーだけでなく、コミュニティ全体が参加できる。

• Discussionで利用可能なオプション（お知らせ、全般、アイデア、アンケート、Q&A、表示と通知）

• 全般
  • 特定のカテゴリに属さない、一般的な話題や質問を投稿
  • 挨拶、軽い雑談、意見交換など。

• お知らせ
  • プロジェクトやコミュニティに関する重要な情報やアップデートを共有
  • リリースノート、イベントのお知らせ、メンテナンス情報など。

• アイデア
  • 新しい機能や改善案についてのアイデアを共有、議論
  • 新しい機能の提案、既存機能の改善案など。

• アンケート
  • プロジェクトやコミュニティのメンバーに意見を尋ねるためのアンケートを作成・共有
  • 新機能の優先順位を決めるための投票、意見調査など。

• Q&A
  • 質問を投稿し、コミュニティからの回答を得る
  • コードに関する質問、使用方法に関する疑問

• 表示と通知
  • 各ディスカッションの表示オプションや通知設定を管理する場所です。
  • ディスカッションのスレッドをフォローする、特定のタグに通知設定を追加

• コメントをDiscussionの回答としてマークする方法を特定する

• DiscussionをIssueに変換
• Discussionをピン留め

Notifications †

Gists, Wikis, and GitHub Pages †

ハンズオン †

https://github.com/alterbooth/hol-github-foundations/blob/main/domain3/README.md

ドメイン4：Modern Development †

ドメイン5：Project Management †

ドメイン6：Privacy, Security, and Administration †

ドメイン7：Benefits of the GitHub Community †

     

Site admin: dotNetDevelopmentInfrastructure

PukiWiki 1.4.7 Copyright © 2001-2006 PukiWiki Developers Team. License is GPL.
Based on "PukiWiki" 1.3 by yu-ji. Powered by PHP 5.3.3. HTML convert time: 0.067 sec.