Githubでのコントリビュートの仕方

 先日、最近お気に入りのサービスであるHyper.shのコマンドラインツールにバグを見つけたので、修正してプルリクを投げた。Githubで。これを振り返って、Githubでのコントリビュートの仕方をざっくりと書いておく。

 前準備として、Githubアカウントを持っていて、Githubのデスクトップアプリも入れておく。

・フォークする
コントリビュートしたいライブラリのGithubページをブラウザで開く。右上にForkというボタンがあるのでクリック。それでフォークが行われる。ここでのフォークとは、自分のリポジトリにそれがコピーされるということ。


 自分のGithubページにいけば、フォークされたライブラリが確認できる。


・自分のローカル環境に、ライブラリのファイル一連を落とす
 デスクトップのGithubアプリを開いてクローンする。


 クローンしたら、バグの箇所を直す。そして自分のところにコミットにして、Githubサーバと同期をとる。

・プルリクエストを投げる
 再びブラウザに戻って、プルリクエストを作る。


 なにをしたかをタイトルにつけて、詳細を本文に書く。今回は本文にはどういう環境、状況でバグが出て、それに対してどう修正を行ったかを書いた。
 テストの実行云々はCIが組まれていれば、プルリクエストを投げた時に自動で行われるのでこまごまと書く必要はない。
 

 ここまでやったらあとは向こうのリアクションを待つ。向こうにも都合があるかもしれんので、マージされるとは限らない。
 あとライブラリによってはコントリビュートにルールが設けてあったりする。コード修正の時のコーディング規約とか。そこらはルールに従って臨機応変に。
comment: 0