Skip to content

Instantly share code, notes, and snippets.

@xyzzy-17-638
Created March 2, 2012 22:58
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xyzzy-17-638/1962125 to your computer and use it in GitHub Desktop.
Save xyzzy-17-638/1962125 to your computer and use it in GitHub Desktop.
名無しさんのための GitHub 3分クッキング

名無しさんのための GitHub 3分クッキング

対象者

  • 名無しさん
  • git (ぎっと) とか知らない
  • GitHub (ぎっとはぶ) は、なぜか名前だけ知ってる

なにができるようになるの?

  • xyzzy (マルチフレーム版) のドキュメント類がブラウザで書けるようになる
  • 書いた結果を作者に送信して、相手が納得したなら取り込んでもらえる
    • 注 : ここでの「作者」とは、xyzzy の作者の亀井さんではなく、マルチフレーム版の作者さんのこと

怒られたり、壊れたりしない?

  • 悪さをしない限り、怒られたりはしない
    • 悪さっていうのは悪意をもって何かをすること。わからない人は、お父さんお母さんに聞いてね!
  • 間違った操作をしても、ほかの人のデーターを壊すことは無い
    • 一番最悪の場合でも、これから作るキミのアカウントが消える程度

必要なもの

  • Webブラウザ

OK、準備は良いようだ。

アカウントを作る

我々、名無しにとっては残念なことに GitHub はアカウント制のサイトなんだけど、 アカウントの登録は無料ゲーム程度の気軽さでできる。捨てメアド&捨てアカで登録しよう。

  • live.jp へ行き、てきとうにメアドを作る
  • github.com へ行き、↑のメアドを使ってアカウントを作る

名無しさんのまま行動する場合、名前に xyzzy と入れておけば、スレから来た人だと認識してもらえるはず。

ユーザ名とパスワードは忘れないように、チラシの裏か手のひらにメモっておこう!

Fork (ふぉーく) する

なんで Fork というのかは知らないけど、 要するに GitHub のサーバー上にキミ専用のフォルダを作って、xyzzy のファイルをコピーする操作。

  • GitHub にログインする
  • https://github.com/mumurik/xyzzy を開く
  • そのまま、GitHubでのキミのユーザ名の下あたりにある「Fork」を押す
  • Fork が実行され、https://github.com/GitHubでのキミのユーザ名/xyzzy という新しい URL に自動的に移動する

これで完了。GitHub のサーバー上にキミ専用のフォルダができた。ついでに xyzzy のファイルもいろいろコピーされてる。 移動した新しい URL はブックマークしておこう。

編集する前に

さっき Fork してできた、https://github.com/GitHubでのキミのユーザ名/xyzzy という URL に移動する。

左上のところに「GitHubでのキミのユーザ名/xyzzy」と書いてあって、 その下に「forked from mumurik/xyzzy」(ふぉーくど ふろむ ほにゃらら) と書かれていると思う。

これは、今見えている場所は GitHub のサーバー上にある xyzzy という名前のキミ専用のフォルダで、 画面の下のほうに見えているファイルとフォルダは mumurik さん (マルチフレーム版の作者) の xyzzy というフォルダからコピーしましたよ、という意味だ。

要するに、このフォルダはキミ専用なので、どんなことをしても、他の人に迷惑はかからない。 ファイルを変なふうにいじったり、フォルダ全体を消したとしても、 mumurik さんのところからまたもらってくれば済む話。

のでまーつまり、ここでは気軽にやっておk、ということ。

あ、このフォルダを操作できるのはキミだけだけど、閲覧は誰でもできる。 つまり、全人類の皆さんからも常時見え放題なので、その点だけ、ちょっぴり注意してね。

編集して Commit (こみっと) する

下のほうに見えているファイルをクリックすると、ファイル閲覧画面になる。

閲覧している内容の右上のほうに「Edit this file」(えでぃっと でぃす ふぁいる) というボタンがあるので、 それを押すと編集画面になる。

編集できたら、編集画面の右下のほうにある 「Commit Changes」(こみっと ちぇんじず。通称「コミット」) というボタンを押すと、サーバーに保存される。 逆に言うと、「Commit Changes」を押さない限りサーバーには保存されない。

編集結果を、作者宛てに Pull Request (ぷる りくえすと) する

納得いくまで編集と Commit ができたなら、 作者に結果を送信しよう。

結果の送信のことを GitHub ではなぜか Pull Request (略称PR) と言う。 なんか分かりにくい名前だけど「編集結果を受け取ってね」ぐらいの意味だ。

Pull Request するためには、画面の右上のほうにある「山 Pull Request」というボタンを押す。

ボタンを押すと、メールの送信フォームみたいな画面になる。 ていうか実際に、これは作者宛のメールフォームだと思って良い。

画面に説明が全然なくて不親切だけど、

  • 小さい横長の空欄が「件名」の欄。「どんな編集をしたか」を簡単に書こう
  • 大きい長方形の空欄が「本文」の欄。「編集した結果が反映されると、どんなことが良くなるか」を書こう

書けたら、右下にある緑色の「Send pull request」 (せんど ぷる りくえすと) ボタンを押す。

ボタンを押すと、作者の Pull Requests ページに移動する。 いま書いた送信フォームの内容が反映されているはずだ。

とりあえず、あとは作者からの返答待ち。ゆっくり待とう。

返事が来た!

作者から返事が来ると、右上の「Å」アイコンのところに、「1」とか数字が付く。 「Å」アイコンを押すと、返事の一覧が出るので、「Re: キミが送った件名」と表示されているところを押そう。 さっきの Pull Requests のページが表示され、作者からの返事があるはずだ。

  • ついでに捨てメアドのほうにも、メールが届く

で、作者からは、だいたい3種類の返事が来る

  • 「受理」タイプ:受け取りました

    • 将来のリリース時に変更が反映される、ということ。やったね!
  • 「却下」タイプ:受け取れません

    • 残念
    • 「却下」された場合でも、キミの変更すべてを否定しているわけではない
    • スレで相談するなりして、皆の意見ももらって、再チャレンジしてみよう
  • 「差し戻し」タイプ:このままでは受け取れませんので、修正して欲しいです

    • この場合、修正して欲しい点を教えてくれる
    • 一番多い返答なのでメゲないようにしよう
    • ムッとくるかもしれないけど、返事をよく読めば、相手が指摘しているのは文章のごく一部のはず。パパっと直そう
    • GitHubのキミのフォルダに戻って、編集して、Commit したら即座に作者に伝わる
    • 編集が落ち着いたら、Pull Requests のところに「もう一度見て欲しい」と書こう
  • TODO : 以下わかりにくい

「受理」されるか「却下」されると、Pull Requests のページが赤い「Close」になる。 「差し戻し」(作業中)の場合は、緑色の「Open」となっている。

以下webuiからやったことないので実験するまで保留

  • 送ったあとは?
  • webui で本流と同期を取ることはできるのか?
    • Network タブ下の Fork Queue タブを使う
      • 取り込むコミットにチェックをつける
      • ドロップダウンから "Apply" を選択
      • "Update Branch" ボタンを押す
      • いや、これ自分の手元に差分を適用するだけで、同じにならない
  • 面倒ならリポジトリ丸ごと削除して、もう一度 Fork でも良い?
    • あんまりな運用だけど…
@mumurik
Copy link

mumurik commented Mar 3, 2012

おー、いいんじゃないかなぁ。PR出しても勝手には反映されず受け取るかどうかは私が判断ってのが分かるといい気もするが、わかりにくくなるだけか。

@xyzzy-17-638
Copy link
Author

ブラウザからは新規ファイルは作れないぽい(?)

@mumurik
Copy link

mumurik commented Mar 3, 2012

そうなんだよね。たぶん無理ぽ。だからひな形のcommitはこっちがしてやる必要がある。まぁやるですよ。
ちなみにこのドキュメントは2chにリンク貼ってOK?wikiには貼ったが。

@xyzzy-17-638
Copy link
Author

リンクはどこでもどうぞー。書きかけすぎですが、「ドキュメント書きたいから説明してちょ」という人が現れるまでには体裁だけは整えたいです。
ほんで運用上での経験を書き足してもらえば良いと思ってます。

@mumurik
Copy link

mumurik commented Mar 3, 2012

了解です。とりあえずREADME.mdとか入れとくかなぁ。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment