4.GitHub - YukaKoshiba/MyknowledgeDocs GitHub Wiki

GitHub @Japanese Version
Create Date：2024/05/14
Last Update Date：2025/8/29

GitHub概論　 GitHubで出来る事　 用語 参考

使い方： 公開範囲とリポジトリ数　 アカウント

インストールと環境設定： 環境設定

作成　 READ.me ローカルリポジトリの作成　 プロジェクト　 issue　 コミット/プル　 Wiki

Markdown記法：
GitHub公式ページ
見出し(hタグ)
文字のスタイル　 引用文　 コード　 リンク(aタグ)
画像(imgタグ)　 リスト(liタグ)　 タスクリスト　 メンション　 フッター　 注記
コメント　 マークダウン記法の無視(エスケープ)　

オープンソースプロジェクトに参加する

(下線は11.用語集に説明を記載)

GitHubの登場

"SOCIAL CODING"という新しい概念を作り上げたサービス
→GitHub以前は、"コミッタ"と呼ばれる一部の特権階級を持つ人だけがソフトウェアのソースコードを改変させる主権を握っており、
手間も時間もかかり面倒なソフトウェア開発になっていた
GitHubの登場により、ソースコードが民主化され、誰でも平等にソースコードを改変できるようになった

SOCIAL CODINGの必要性 IT業界では特に人材流動が高まっており、ソフトウェアを作成したエンジニアがいなくなることも日常茶飯事となっている
ソーシャルコーディングをしていないと、開発者や保守担当者がいなうなった際に、誰もソースコードを触れず、保守できないレガシーシステムが生まれてしまう
また、採用の観点からも、今まで書いてきたコードを閲覧でき、最新のソフトウェアに精通しているプログラマの方が、圧倒的に採用したいプログラマと言える
GitHubを利用すると、世界の知見を得られ、異文化交流も可能

"Pull Request"という機能により、世界中どこにいてソースコードの共有ができる
・どこでも一緒に開発ができる
・スピード感のあるレビューができる
・書いた本人以外もわかるコード
・本番環境にデプロイ※されているコードの把握
・他エンジニアのコードを見て、知識共有や相互作用、指摘、改善ができる
・1日に何個もの機能を追加できるシンプルで高速な開発ワークフローの作成
・書き間違い、思い違いといった簡単なミスによる不具合を減らす
・オープンソースプロジェクトに参加して、プログラミングの練習が出来る

GitHubで開発されているソフトウェア

• GitとGitリポジトリ
  Gitは、GitHubとは別物で、"Gitリポジトリ"というデータの貯蔵庫にソースコードを入れて利用するもの
  Gitで管理し、インターネット上で利用できるようにしたものがGitHubよいうサービス
• ホスティングサーボス
• オープンソースソフトウェア
• デプロイ
  開発したソフトウェアを実際の運用環境に配置・展開し、システムを利用可能な状態にすること
• GitHub社
  アメリカサンフランシスコを拠点とする会社
  octocatと呼ばれるタコと猫を掛け合わせたマスコットキャラクターが特徴
• ブランチ
  変更履歴の流れを分岐して記録しているもの
  同じリポジトリ内の他ブランチ作業の影響を受けずに、分岐したブランチに対し同時に作業を行う事が出来る
  また、分岐したブランチは他のブランチとマージ(合流)して、1つのブランチに再度まとめられる
  スナップショットとして保持している
  ※変更や差分としてデータを保持してない

GitHubで提供するGitリポジトリは、基本的に無料で、何個でも作成できる
公開範囲を限定したい場合には、毎月の定額プランに入会する必要がある

• Pull Request
  ソースコードをGitHubのGitリポジトリへ送る機能
  この動作をすることで、自分のローカルにある最新のソースコードをチームで見られる環境へアップできる
• Watch
  興味のあるリポジトリをWatchとして登録することで、関連情報がNews Feedに流れてくる
  Twitterのフォローのイメージ
• Star
  興味があるリポジトリに目印を立てる機能(再度開いた際に探しやすくする)
  Twitterの良いねのイメージ
• Issue
  1つのタスクや問題を1つのIssuに割り当て、トラッキングや管理を行えるようにする為の機能
  バグ管理システムのような使い方やチケット駆動開発のチケットのような使い方もできる
  1つの機能変更や、修正が1つのIssueとして割り当てられる為、Issuを見ればその変更に関する全てがわかり、管理できる
  Closeすることも可能
• Wiki
  いつでもだれでも文章を書き替えて保存でき、共同で文書を作成できる
  開発ドキュメントやマニュアルなどの掲載に利用され、掲示板の様な役割
• Fork
  他の組織(またはユーザー)のリポジトリを自分のアカウント下に複製する操作
  それぞれの数が多いほどたくさんの人に注目されていることになる

インストール作業中の画面

動作確認 Git Bushを起動し、バージョンをコマンドを送信し、正しくレスポンスされれば、インストール完了
※Git Bushは、Gitに対してコマンドを送信するもので、Windowのコマンドプロンプトからではコマンドを送信できない

設定内容の確認して、正しく設定できていることを確認

必須ではないが、アイコンが見えた方が安心感がある
GitHubので利用されるアバターは、Gravatarというサービスを使用して表示される
GitHubに登録したメールアドレスを登録すると、自動的にアバターが設定される
https://gravatar.com/

SSH Keyの設定

作成したリポジトリのアクセス認証をSSHを利用した利用した公開認証で行う
公開認証に必要なSSH Keyの作成と、GitHubへの公開鍵登録を行う
SSH キーを使うと、アクセスのたびユーザー名とpersonal access token を入力することなく、GitHubに接続でき、SSH キーを使ってコミットに署名できる
※既に作成したリポジトリに対しては、既存の鍵の利用を設定する必要がある

パスフレーズ：認証の際に利用する為、覚えやすく、複雑なものにしておく

GitHubに公開鍵を登録して、秘密鍵の認証が出来るようにする SSH and GPG keys > New SSH Key

→登録が完了すると、メールが届く

オプションを設定して、"Create repository"をクリックする

オプション選択

リポジトリのトップページに自動的に表示される
一般的に、ソフトウェア概要、利用の為の手順、ライセンスが明記されている

Markdown記法で記述すると、わかりやすくマークアップされる

詳細は、GitHub公式ページ参照のこと

# h1
## h2
### h3
#### h4
##### h5

** 太字 **

__ 太字 __

Ctrl + B

Command + B

* 斜体 *

_ 斜体 _

Ctrl + I

Command + I

*** 太字と斜体 ***

~~ 取り消す文字 ~~

~ 取り消す文字 ~

<ins> 下線 </ins>

<sub> 添字 </sub>

<sup> 上付き文字 </sup>

> 引用文

ショートカットキー：

Ctrl + E

Command + E

 `コード文`

HEX、RGB、HSLのカラーパレットは、サポートされている

ショートカットキー：

Ctrl + K

Command (+ SHIFT) + V

[表示名](URL)

![表示名](パス)/code>

インデントを入れると、入れ子構造にすることもできる

- ・リスト
* ・リスト
+ ・リスト

1. リスト1
2. リスト2
3. リスト3

- [x] チェック済
- [ ] チェック項目
- [ ] チェック項目

@メンション内容

フッターを付けたい文章[^1]
フッターを付けたい文章[^2]

> [!NOTE]
> 青字で表示される詳細事項

> [!TIP]
> 緑字で表示されるコツ

> [!IMPORTANT]
> 紫字で表示される重要情報

> [!WARNING]
> 黄色で表示される重要な事項

> [!CAUTION]
> 赤字で表示される注意事項

HTMLのコメント文と同じ

<!-- コメント文 -->

\エスケープしたい文字\

リポジトリのお気に入り登録 Watchしたいリポジトリがあれば、スターマークを付けると登録できる
メールで変更を受信することも可能
ただし、"All Activity"にすると、スパムメールの様になる為、やめた方が良い

制約事項

• CSSを使用できない　(参考)

裏技

• 画像のアップロード方法
  　issueに画像をアップロードし、本来アップロードしたいWikiにURLを張り付ける 　(参考)
• ページの階層関係の作成
  　GitHub Wikiにサイドバーを追加し、ページの階層関係を記述する 　(参考)

GitHubで学習コミュニティや開発者コミュニティに参加することができる
チュートリアルや実践で、プログラミングに関する十分なスキルと知識への自信が付いたら、開発者コミュニティに参加して、オープンソース プロジェクトに貢献しながら、プログラミングの練習がおススメ