📚

GitHub備忘録

2023/04/17に公開

GitHub

私に取ってのGitHub

GitHubはエンジニアとして働く中でほぼほぼ必ず使うツールであり、コード管理などをしてくれるありがたいツールですね。また、profileの真ん中の方に自分がコミットしたりすると緑色に染まっていくカレンダー的なものもあって、私はそこに草を生やすこと(緑に染めていくこと)がモチベーションの1つになっています。

また、個人的にですがUIなどもいいなと感じていて、操作もしやすいなと感じています。
そして、後で紹介するのですが、GitHub Copilotなるものが最高にクールなものになっていまして、日々技術の進歩に驚かされています。

そんな中ではありますが、設定しておきたいものや使いたいツール・困ったことの解決方法などを紹介していきたいなと思います。
しかし紹介とは言ったものの、自分がパソコンを買い替えた時やアカウントを作り直した時などにこの記事を見ながら設定できるようにしていきたいと思います。笑

※初歩的なことを多く含んでますので、そこら辺はご了承ください。

SSH キーの追加

SSHとはSecurity Shellの略で、遠隔でログインや特定のサーバーに入ったりするために使われることが多く、通信を暗号化してくれるので第三者には簡単に解読されないようになります。
HTTP通信もあるので必須ではないかとは思いますが、HTTPの場合、悪意を持った第三者に傍受されたりすると簡単に通信の中身が見えてしまうので、SSHの設定で安心しながら開発したいと私は思います。

コミットメールアドレス

エンジニアの方の多くは、Organizations(組織)に所属して、その中のリポジトリでpushしたりプルリクエストするかと思います。

そうやって作業していたときに
自分のprofileの方に草が生えてない
ということに気づきました。

原因はコミットメールアドレスを設定してなかったからでした。
草を生やすことがモチベーションの1つとなっている僕からしたら、致命的な設定ミスでした、、、。

下記を参考にすれば、簡単に設定できます。

これを設定することによって、毎日の活動を記録していきましょう。

GitHub Copilot

冒頭でも触れたGitHub Copilotのご紹介です。

最近何かと話題のAIの話を聞くと、シンギュラリティくるな〜()と感じます。笑
Open AIのChat-GPTなどはエンジニア界隈ではもちろん、一般の方にも知れ渡るほどのインパクトを与えており、ここからさらにITの進化が進んでいくんだろうなと感じます。

上記URLを設定すれば簡単にcopolotを導入できます。

※こちらのサービスは2023年4月現在では、30日間の無料トライアルがありますが、その後は有料になりますので、お気をつけください。

また、これも念のために設定しておいた方がいいなと思ったのは、下記写真の
Allow GitHub to use my code snippets for product improvementsの部分です。

こちらは簡単にいうとcopilotが自分のコードを参考に、第三者をサポートすることを許可するかどうかです。
若干情報漏洩のリスクを感じたりするので、一応私はチェックを外しています。

Projectについて

これは設定というより困ったことの共通です。
Githubのproject画面にてgitのissueを表示・管理していく場合もあるかと思いますが、以下の画面のように新たな項目として列追加して表示項目を変更したにもかかわらず、ブラウザを再表示したら以前の表記に戻っていたり、他のメンバーには変更内容が反映されない場合があります。
(その場では反映しており、リロードしても大丈夫なのですが、、、。)

そんな時は表示内容変更後に以下の画面のSaving changesのボタンをクリックしてみてください。
変更内容が保持され再表示しても変更内容は消えず、他のメンバーにも同じ内容を共有できます。

プルリクの添付画像について

privateなリポジトリでも、プルリクの添付画像については承認なしで誰でもみることができると、一時期豆知識として話題になったのを覚えています。
公式にもちゃんとwarningで書かれているらしいので、ここは注意しながら操作していきたいですね！泣

VSCodeでの拡張機能

ターミナル上でコマンドを使用しながらcommitなどをしている方も多いかと思いますが、たまにミスってリポジトリがどうなってるか不明瞭になってしまうことがあるかと思います。logなどを出して確認するのも一つの手なのですが、VSCode上でUIとして確認することができます。
Git Graphという拡張機能を入れることによって、自分がどのブランチをどのように進めていってるか、どのようなcommitをしているかなどがわかるので、便利だな〜と思いました。

Profileをシャレオツに

これは自分的にテンションの上がったものなので、チラッとご紹介です。笑
下記URLを参考に、自分のprofile部分に格好いいグラフなどを簡単に出せます。
一応人に見られることも意識したいし、見られた時に「こいつちょっとこだわってやがるな。ええやんか。」と感じて欲しいなと思って私も少しですが実装してます。(ちなみに私は気分屋なので、作業途中です😆)

最後に

自分の使ってるツールについて知見を深めるためにgithubの公式ドキュメントや記事などを読んでみようと思ってこの記事を書きました。もちろんまだまだ知らないことはいっぱいありますし、経験したことないことなどもあるのですが、今後何かあったらここに追記していきたいと思います。
また、今後も自分の使っているツール(AWS、Docker、Supabase、Firebase、Netlify,etc...)などについても詳しくなっていきたいなと思いました。