誰にでもわかる(ことを目指した) “Pull request を送るまで” マニュアルを作成したよ #yochiyochirb

バレンタインデーに作っていたのは、チョコではなく wiki でした。

よちよち.rb で自己紹介ファイル等を追加・編集する際に Pull request を使用してもらうようにしたのですが、まだ PR を送り慣れていない方のために、リモートリポジトリを clone してから PR を送りマージするまでのマニュアルを作成しました。

Home · yochiyochirb/meetups Wiki

目指したのは、「あの頃の私が欲しかったマニュアル」です。ていうか よちよち.rb 自体、「あの頃の私が欲しかったコミュニティ」ですからね。あの頃っていうか 今もですけど。

また、ブランチを作る前にgit pull --rebaseをするということなど、最近よちよち.rbに参加するようになった方へはアナウンスしそびれていたことがある ということに、Network graph を見て気づきました。いろいろと混乱させてしまい、申し訳なかったなあと思います。(Github 練習回のころからいらした方々とは、pull –rebase にするか merge にするかを相談したりしていたので、その時に方針をお伝えしていました)

そういった意識合わせのためにも、PR を迷いなく送れるメンバーの方も含め、お手数ですが目を通していただきたいなと思っています。

いや~~~~~~しかし、これ多分、人生で一番頭をつかって書いたんじゃないかな。
後のほうになるにつれてだんだんザックリしてきたり体系的でなくなったりしているかもしれません。また改めてクオリティの向上に努めようと思いますが、なにかオカシなことが書かれていたら、ぜひ教えてください。

ところで、Github wiki もふつうのリポジトリみたいに clone して編集できる ということを、今回初めて知りました。
wiki のページで ‘clone URL’ ボタンを押すといつもどおりリポジトリの URL がクリップボードにコピーされるので(プロトコルは HTTPS だった)、

clone_url

それを使ってgit cloneコマンドを実行すると、[リポジトリ名].wiki というリポジトリが作られるようです。

ll

_Sidebar.md とか _Header.md といった名前のファイルを作ると、Github wiki 上ではサイドバーやヘッダとして表示されたりするみたい。けど、かっこよすぎて私はまだ使ったことがありません。

…なんて調べていたら Github wiki ではこの Gollum という wiki エンジンを使っているということを知りました。
gollum/gollum

よい勉強になりました✍✍✍

ということで、どうぞよろしくお願いします~!


コメントを残す

メールアドレスが公開されることはありません。

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>