[#153/#155] GitHub 初心者ガイドを深掘りレビューする

[ootakazuhiko]

背景

親ロードマップ: itdojp/it-engineer-knowledge-architecture#153
Phase 2 管理 Issue: itdojp/it-engineer-knowledge-architecture#155

本書は GitHub / AI 開発プロセス系レビューの入口となる。GitHub UI、Repository、Issue、PR、Actions、Pages、Docs-as-Code の基本説明が現行仕様と整合しているかを確認する。

推奨順

Phase 2 の 1番目に実施する。

理由: GitHub の基本用語と操作説明は、後続の github-workflow-book、GitHub-AgentOps-book、AI 開発・テスト関連書籍の前提になるため。

作業範囲

• GitHub UI、Repository、Branch、Commit、Issue、PR、Review、Actions、Pages の説明を確認する。
• 初心者向けの操作手順が現行 UI と大きく乖離していないか確認する。
• Issue / PR / review / CI / merge 後確認の用語が Phase 1 の書籍群と矛盾しないか確認する。
• 秘密情報、個人情報、AI/外部サービス投入、公開リポジトリ利用時の注意が過不足ないか確認する。
• 章末問題、付録、チェックリスト、テンプレートが本文と整合しているか確認する。

チェックリスト

現状確認

• default branch を確認する。
• open Issue / open PR を確認する。
• CI の有無と最新状態を確認する。
• build / lint / spellcheck / test コマンドを確認する。
• 公開サイト URL を確認する。
• README / CONTRIBUTING / LICENSE を確認する。
• 章構成を確認する。
• docs/ / src/ 同期構造を確認する。
• 生成物の有無を確認する。

内容監査

• GitHub UI / Actions / PR / Issue の記述が現行仕様と整合している。
• 初心者向けの前提条件、操作手順、注意点が明確である。
• Issue / PR / review / CI / merge 後確認の用語が Phase 1 と整合している。
• 公開リポジトリ、秘密情報、個人情報、AI/外部サービス利用に関する注意がある。
• github-workflow-book との責務分界が明確である。

PR / 完了条件

• 発見事項と変更判断を Issue コメントまたは PR body に記録する。
• 本文変更がある場合は適切な粒度で PR を作成する。
• PR で GitHub Copilot review を受ける。
• review 本文・inline comment・suggestion を全件確認し、必要な修正または不要理由を返信する。
• 未解決 review thread 0 を確認する。
• CI green を確認する。
• merge 後 main checks と公開サイト反映を確認する。
• 完了証跡を本 Issue と [#153] Phase 2: GitHub / AI 開発プロセス系 7冊の内容レビュー計画 it-engineer-knowledge-architecture#155 に記録する。

[ootakazuhiko]

着手時点の現状確認を記録します。

• default branch: main
• open PR: なし
• open Issue: 本 Issue のみ
• 作業用 worktree: /home/devuser/work/CodeX/booksB/worktrees/github-guide-for-beginners-book/review-20260523
• 作業ブランチ: codex/github-guide-review-20260523 from origin/main
• HEAD: 9d35e16 (Rename PR link label on top page (#217))
• 構成:
  • docs/ 配下に現行公開用章ファイルあり
  • src/ 配下にも旧/別系統の章ファイルあり。ただし docs/ と同一構成ではないため、変更対象は内容確認後に判断する
• 公開サイト smoke:
  • /, /chapters/chapter-introduction/, /chapters/chapter-issue-management/, /chapters/chapter-pull-requests/, /chapters/chapter-github-actions/, /chapters/chapter-security-best-practices/ は HTTP 200
• ローカル検証:
  • npm ci: 成功。ただし npm audit は 10件（4 moderate, 5 high, 1 critical）を報告。本文レビューとは分離して扱う候補
  • npm test: 失敗。src/**/*.md の既存 markdownlint MD012/no-multiple-blanks が多数
  • npm run docs:quality-gate: 成功
  • npm run build: 失敗。グローバル jekyll 4.4.1 と Gemfile 要求 jekyll 4.3.4 の競合。bundle exec jekyll build は成功

次に、GitHub UI / Issue / PR / Actions / Pages / Security の記述を、公式ドキュメントと現在の本文に基づいて監査し、必要な修正を小さな PR にまとめます。

[ootakazuhiko]

完了証跡です。

• PR: [codex] セキュリティとPR完了ゲートを現行運用に合わせる #219
• merge commit: ba8961be66648c2f270c8d6be687cdcc4453adb7
• 対象: manuscript/** を正本として、対応する docs/** へ同期
• 主な変更:
  • 2FA / パスキー / セキュリティキー / TOTP / SMS の位置づけを更新
  • PR の最小完了ゲート（レビュー、未解決 thread 0 件、CI、merge 後確認）を追加
  • GITHUB_TOKEN と permissions の最小権限例を追加
  • PAT / secret scanning / push protection / ruleset の説明を更新
  • GitHub 公式Docs参照を付録に追加
• Review:
  • GitHub Copilot review: 3 comments。全件修正・返信・resolve 済み
  • Codex review: 1 comment。manuscript/** 反映と docs/** 同期で対応済み
  • review completeness: status=ok, review_threads=4, unresolved_threads=0, generated_count_mismatches=0, missing_review_ids=0
• PR CI: qa, docs-forbidden, docs-quality-gate が成功
• merge 後 main checks: Docs Forbidden Check, Docs Quality Gate, Book QA, pages build and deployment が成功
• 公開サイト確認: 第4章、第7章、第9章、第10章、付録Cで反映マーカーを確認済み
• branch cleanup: codex/github-guide-review-20260523 をローカル・remote とも削除済み

残課題候補:

• src/**/*.md の既存 markdownlint baseline 整理
• npm audit 10件の依存関係更新