🐈

初めてのOSS Contribute【First Contributions編】

2022/09/18に公開

https://firstcontributions.github.io/


Make your first open source contribution in 5 minutes.

君も5分でOSSコントリビューターだ!(意訳)

「OSS活動への貢献してみたいけど、まずどうすれば良いのかよくわからないな」と思って調べていた時に発見した上記のありがたいプロジェクトで、OSSコントリビュータデビューさせてもらった時の備忘録です。

OSSにPR出してみたいけどぶっつけ本番は緊張する、貢献したいOSSとかまだあんまり決まってない(けどやりたいとは思ってる)人がもしいれば、このプロジェクトの胸を借りることをお勧めします。


流れのまとめ

  1. First ContributionsのリポジトリでPRを出す流れを体験させてもらう
  2. サイトのプロジェクトリストを参考に作業するリポジトリを探す
  3. ↑のREADMEやContribute.mdなどでルールを確認(大事)
  4. 1.の要領でPRを作成、修正、マージ

PRの手順

基本的にはリポジトリのREADMEに沿って進めるだけです。5分もかかりませんでした。
(様々な言語で翻訳されていて、コミュニティの大きさを感じます)

簡単な手順は以下の通り。

  1. リポジトリをフォーク
  2. フォークしたリポジトリをクローンしてくる
  3. ブランチを作成
  4. コードを変更してコミット
  5. Push
  6. PRを送る(githubで自分のリポジトリに行くとCompare & pull requestボタンが表示される)

これで完了です!
記念すべき人生初OSSコミットがこちら

botの手ですぐにmergeされていきました。

練習が終わったら本番

PRを出すまでの流れを実際に体験できたので、いよいよ他のOSSにPR出していくぞ!という流れなのですが、貢献したいコミュニティが最初から決まっている場合を除くとどこのリポジトリにどういう作業をさせてもらおうか悩む、というか目星をつけられなくて困ると思います。少なくとも私は困りました。
ですがその辺りもFirst Contributionsはカバーしてくれていて、ネクストステップとして取り組みやすいプロジェクトのリストを用意してくれています。(一番最初に貼ったURLと同じです)

https://firstcontributions.github.io/

ここで自分で使っている言語や諸々で絞り込んで、気になったリポジトリのissue等を見ていくと、すぐに取り組めるタスクがあったりします。
(もしくは実際に使ってみて、気になる箇所があればissueやそれに対するPRを立てたりもできます)

私の場合は、興味があったリポジトリに誰でも取り組んで良い「ファイルごとのテストカバレッジを100%にする」issueが立っていたのでそれに着手しました。

大体のリポジトリはREADMEやContribute.mdなどに貢献の方法やルールが明記されているのでまずはそれを見て、しっかりそれらを守りつつ作業することを心がけましょう(自戒)。

記念すべき人生二度目OSSコミットがこちら

余談

  • OSSコントリビューションというと花形のPRに目が行きがちですが、issueでのエラー報告も立派な貢献になるみたいです。言われてみれば確かに、実装中エラーに当たった時OSSのissueにはいつもお世話になってます。
  • カタカナ表記の場合、リポジトリ派閥とレポジトリ派閥があることに気がつきました。IT用語辞典などでも併記されているので、完全に好みの問題みたいです。
  • 軽い気持ちでやったFirst Contributionsさんのお試しPRでしたが、これひとつでfindyさんの偏差値が結構上がりました(!)。OSSへの貢献はエンジニアのハードルの一つなのかも知れないですね。

Discussion