Skip to content

README.md

Latest commit

 

History

History
192 lines (131 loc) · 6.74 KB

README.md

File metadata and controls

192 lines (131 loc) · 6.74 KB

GitHub初心者ガイド - バージョン管理の基礎から実践まで

GitHub Guide for Beginners License Language

📖 書籍について

この書籍は、Gitとgithubを初めて学ぶ方から、基本操作は知っているが体系的に学び直したい方まで、幅広い読者を対象とした実践的なガイドブックです。

🎯 対象読者

  • プログラミングを始めたばかりの学生・初心者
  • これからチーム開発に参加する方
  • 独学でコードを書いているが、バージョン管理を使ったことがない方
  • GitHubの基本操作は知っているが、ワークフローを体系的に学びたい方

✨ 特徴

  • 実践重視: 実際の開発現場で使われるワークフローを重視
  • 段階的学習: 個人利用からチーム開発まで段階的にスキルアップ
  • トラブル対応: よくあるエラーとその解決方法を詳しく解説
  • 最新対応: GitHub Actions、GitHub Pages等の最新機能にも対応

📚 書籍構成

第1部: 基礎編

  1. 第1章：はじめに - なぜGitHubを学ぶのか
  2. 第2章：Git基礎 - バージョン管理の仕組み
  3. 第3章：初めてのリポジトリ作成
  4. 第4章：アカウントセキュリティの基本

第2部: 実践編

  1. 第5章：ファイルのアップロードと管理
  2. 第6章：GitHub Desktop の活用
  3. 第7章：ブランチの基本操作
  4. 第8章：Issue管理とプロジェクト管理

特別編: Docs-as-Code（文書運用編）

  • 特別編：Docs-as-Code - GitHubをドキュメント管理・ナレッジ基盤として使う

第3部: 自動化・高度活用編

  1. 第9章：GitHub Actions入門 - 自動化の基礎
  2. 第10章：セキュリティのベストプラクティス
  3. 第11章：高度な機能活用
  4. 第12章：トラブルシューティング

付録

  • 付録A：Gitコマンドリファレンス
  • 付録B：GitHubショートカット集
  • 付録C：学習リソースと参考文献

🚀 使用方法

必要な環境

  • インターネット接続
  • GitHubアカウント（無料）
  • ターミナル・コマンドライン環境

推奨環境

  • Visual Studio Code（または任意のエディタ）
  • Git GUI ツール（GitKraken、SourceTree等）

学習の進め方

  1. 各章を順番に読み進める
  2. 実習コードを実際に動かす
  3. 章末の演習問題に取り組む
  4. 不明な点はIssuesで質問する

🛠 開発・ビルド方法

この書籍は book-formatter を使用して作成されています。

セットアップ

# リポジトリをクローン
git clone https://github.com/itdojp/github-guide-for-beginners-book.git
cd github-guide-for-beginners-book

# 依存関係をインストール（package-lock.json と同期）
# Node.js 20.18.1+ を利用（QA依存の cheerio / undici が要求）
npm ci

# 公開サイトをローカルビルドする場合のRuby依存関係
bundle install

# 開発サーバーを起動（docs/_config.yml / docs を利用）
npm run start

ビルド

# 本番ビルド
npm run build

# メタデータ・ローカル品質ゲート
npm run check:metadata
npm test
npm run docs:quality-gate
npm audit

📝 執筆ガイドライン

コンテンツ作成時の注意事項

  1. SVG図の作成

  2. コードサンプル

    • 実際に動作することを確認
    • コメントで詳しく説明を追加

  3. スクリーンショット

    • 最新のGitHub UIに基づいて作成
    • 重要な部分をハイライト

執筆の進め方

技術書作成の詳細な手順については、tech-book-writing-6phases.md を参照してください。

🤝 貢献方法

バグ報告・改善提案

Issuesを使用してバグ報告や改善提案をお願いします。

  1. バグ報告: 内容の間違いや誤字脱字
  2. 改善提案: より良い説明方法や追加すべき内容
  3. 質問: 理解が困難な箇所についての質問

プルリクエスト

以下の改善については、プルリクエストを歓迎します。

  • 誤字脱字の修正
  • より分かりやすい説明への改善
  • コードサンプルの改善
  • 図表の改善

貢献ガイドライン

  1. Issue first: 大きな変更前にIssueで議論
  2. 小さな単位: 一つのPRで一つの改善を行う
  3. テスト: コードサンプルは必ず動作確認
  4. 説明: PRの説明で変更理由を明確に記載

📄 ライセンス

この書籍は Creative Commons BY-NC-SA 4.0（非営利利用は自由、商用利用は別途契約）で提供されています。詳細は LICENSE.md を参照してください。

利用について

  • 個人学習/教育/研究（非営利）: 自由に利用可能
  • 法人・営利目的での利用（商用）: 事前の商用ライセンス契約が必要（お問い合わせ: knowledge@itdo.jp）
  • 改変・再配布: CC BY-NC-SA 4.0 の条件（表示（BY）/非営利（NC）/継承（SA））に従って可能

📞 お問い合わせ

著者情報

ITDO Inc.（株式会社アイティードゥ）

サポート

  • 技術的な質問: GitHubのIssuesをご利用ください
  • 商用利用の相談: メールにてお問い合わせください
  • 研修・セミナー: 企業向け研修サービスも提供しています

🔗 関連リソース

ITDO Inc. の他の技術書籍

学習リソース

🌟 この書籍が役に立ったら、ぜひStarをお願いします！

最新の更新情報は、このリポジトリをWatchしてください。