Skip to content

frequently asked questions about self introduction

Yuka Kato edited this page Nov 25, 2015 · 9 revisions

Pull Request

🥚コミットを分ける目安って?

「コミットを作る」とは言うけれど、どういう基準で作っていけばいいの?

Answer

原則としてコミットは「目的が同じ操作をひとまとめにする」ように心がけると、結果として Git の特長を最大限まで活かした運用ができるようになる、と yucao24hours は考えています。

よちよち.rb 自己紹介でよくある例:

  • members ディレクトリ配下の自己紹介ファイルを更新する操作(週替りのお題 a.k.a "シュクダイ" についての記述を追加する、等)
  • 自己紹介ファイルをコピーする操作
  • 過去に書いてあった内容が不要になったため削除する操作 etc...

これらはそれぞれ目的が違うので、別々のコミットにしておくと論理的に履歴が追いやすくなるかと思います。

commits

また、機能面でも、git revert (コミット単位でコードを元に戻す)や git cherry-pick (コミット単位でコードをコピーする)をするときのことを考えると、それぞれ別々のコミットにしたほうが後々に操作しやすくなるかと思いますので、よちよち.rb ではそのようにお願いしております。

💡 参考: クリアなコードの作り方: 意図が伝わるコミットのしかた - ククログ(2012-03-13)

ご注意

「コミットが細かすぎるとレビューしづらい」「履歴が汚くなる」といったご意見をお持ちの方もいらっしゃるので、これがどこでも通用する正しい意見!というわけではありません。あくまでも、主催者の yucao24hours の経験による独断と偏見によるものです 🙇

実際に運用する際は同じチームの方々と話しながら方針をあわせてパフォーマンスを最大まで上げることが最も重要ですから、ここに書いてあることは一例として頭の隅っこに置いておく程度に留めておいてください。

よちよち.rb の idobata などでもコミットの粒度について議論がされたことが幾度かあるので、ご覧いただくのもいいかもしれません。

💡 参考: yochiyochirb/Git(ここのルームの search フォームで コミット というワードで検索するといろいろ出てきます)

Gist

✏️どの URL をコメントに書いたらいいの?

「できあがったら、Gist の URL をこちらへ貼ってください」ってあるけど、画面の右端に URL らしいものが複数表示されているし、どの URL を貼ったらいいかわからない。

Answer

Gist を開くと以下のような画面になると思うので、その時にブラウザの URL バーに表示されている URL (下図の赤い矢印が指している箇所)をコピペして、コメント内に記入し投稿( Comment ボタンを押す)してください。

gist

なお、画面の右端にある URL はそれぞれ以下をあらわしています。今回ほしい URL とは異なることに注意してください:

Embed URL

その Gist を外部サイト(たとえばあなたのブログなど)に表示させたい!といったときに、そのまま貼り付けて使うことができる HTML のコードです。

SSH clone URL

その Gist のコードがおいてあるリポジトリの URL です。"その Gist を __ブラウザで表示させるための URL" とは異なりますので、ここの URL にブラウザからアクセスしても上記画像のような Gist は表示できません__のでご注意ください。くわしくはマニュアルの「リポジトリの URL をコピーして持ってくる」をご覧ください。