社会人から始めたプログラミング

プログラミング、エンジニアに関することでの備忘録、シェアしたい情報などを共有するためのブログです。

初めて ruby の gem にコントリビュートのコミットをしてプルリクエスト作ってみた

コントリビューターって?

ここで言ってるコントリビュートとは、 OSSコントリビュートのことで、オープンソースソフトウェアコントリビュートのことです。

公開されているライブラリーに、

  • 「こんな便利な機能作ったよ」とか
  • 「ここ直しておいたよ」とか
  • 「ドキュメント修正しておいたよとか」

という修正、機能追加を行います。 そして、PR (プルリクエスト)を作り、無事マージされれば、晴れてあなたもコントリビューターに! (いつかあなたと同じ壁に当たった誰かを助けることに貢献してくれてありがとう!)

ちなみに、コミッターは gem のリポジトリにコミットする権限を持った方々のことで、 コントリビューターより内部の人感がありますね。(コミッターとコントリビュータの違いわかってなかった…笑)

コントリビュートするための流れまとめ

今回、私は github に公開されている ruby の gem に関してPRを作ったので、 その例でご紹介。

  1. ライブラリーのドキュメントを確認して、コントリビュート時の注意点を確認する。

  2. github の gem(ライブラリー) のリポジトリに行き、「フォーク」というボタンを押して、 gem を自分の開発環境にgit cloneする

  3. 開発環境で、ブランチを切る(feature/xxx とか bugfix/xxxxxx とかすると機能追加か修正かわかりやすいですね)

  4. 開発ブランチ上で機能追加、修正を行いテストも追加する。

  5. 追加、修正が終わったら、自分の開発したものをpush

  6. PRを作成し、なぜこのPRを作ったか、どんな修正をしたか、レビューよろしくって書く。

私の場合、PRはこんな感じでした。

果たしてマージされるのか…?😂 github.com

なぜこのPRを作ることになったかはこちら itoshk-development.hatenablog.jp