🚶🏻

Vue Fes Japan Online 2022 レポート - OSSはじめの一歩

2022/11/20に公開約2,500字

概要

Vue Fes Japan Online 2022の視聴レポートです。

OSS はじめの一歩(動画)
https://vuefes.jp/2022/#oss-first-step

Vue.js をはじめ、多くの OSS は利用者からのフィードバックやコントリビューションによって成り立っています。しかし、協力の意思はあっても、実際どのように参加していけばいいのかわからない方も多いのではないでしょうか?
このセッションでは、実際に Vue.js 日本ユーザーグループにて OSS 開発に参加・協力しているメンバーが、バグ報告やパッチ提供、OSS 開発への参加やドキュメントサポート、そしてコミュニティの運営など、数多くのコントリビューターとどのように進めているのかをご紹介します。

講演メモ&感想

Vue.js日本ユーザーグループの活動は?

  • ノウハウを集めたかったので2015年1月から活動を始めた
  • 最初は有志で翻訳活動をしていくことから始まった。
  • 2017年ぐらいからVueの人気が出てきていろいろコミュニティ活動も始めた
  • 今は翻訳、コミュニティ活動、カンファレンス運営などを行っている

コアスタッフになったきっかけ

  • 最初はドキュメントの翻訳から始めた

コアスタッフというと、コードをバリバリ書けるエンジニアの人が最初から集まっているのかなと思っていましたが、まずは翻訳から初めて徐々に貢献が認知されてコアスタッフになったという方もいるそうです。

OSS活動をとりあえず何かやってみたいという場合は何からやればよいか?

  • issueの回答をしてくれるだけでもメンテナーとしては嬉しい
  • 翻訳活動が手っ取り早い
    • OSSとの関係づくりとしてもよい
    • わりとすぐにレビューされる
  • マージされるとモチベーションもあがる

OSS活動というとissueであがっているバグの修正や新機能の追加などを思いがちですが、翻訳活動といったものも取り組みやすいとのことです。
たしかに、ドキュメントを読むことでOSS自体の理解も深まるし、OSSへの貢献もできるので最初の一歩としては良いなと思いました。

コードがわからないデザイナーでも参加できるか?

  • 参加は可能だがまだ発展段階
  • デザインは明確なバグがわからないで難しい
  • 提案したデザインをドキュメントにしたほうがいい

これは確かに難しいですね。
バグだと期待動作が明確になっているので完成形のイメージがわかりますが、kiakingさんも言っていまいましたがデザインだと好みの問題もあるのでなかなか難しいとのこと。

OSSはじめの一歩でつまずいたり難しかったことは?

  • PRの書き方に迷った。どういう内容だとレビューアにとって見やすいか
    • 早く見てもらいたいのであればPRのサイズを小さくする
    • リファクタリングのようなissueとは直接は関係のない修正を入れない。そういったものは別でissueを立てて対応する

私も先日初めてissueを直してOSSコントリビュートしてみましたが、PRの書き方は悩みますね。
その時の経験としては、以下のようなことに注意して書いてみました。

  • Contributing Guidelineがあり、そこにPRの書き方の指示があればそれに素直に従う
  • 他の人が直した過去のPRを見て、コメントの書き方を参考にする
  • パッと見てわかるように画面のスクリーンショットや実行結果のファイルなどがあれば添付する

翻訳は辞書使いながらでも大丈夫?

  • 辞書を使いながらで大丈夫
  • 最初からきっちりするというよりはOSSなのでもし間違っていたらすぐに直せればよい

これは意外だなと思いました。翻訳というと英語が話せる人がきっちりやっているのかと思っていたのですがそうでもないとのことでした。
間違っていたらすぐに直せばいいというのは確かにOSSならではですね。
ちなみに今回参加されていたjay-esさんのプロフィールにも「現在は Vue 3 新ドキュメント翻訳も担当。昨年 SolidJS のサイトを全部日本語化している。英語は話せない」とありました。

その他いろいろ

  • issueを立ててもらえるだけでもありがたい
  • help wantedなどのissueを直してくれると嬉しい
  • 作ったOSSに何も返信がないと寂しい
  • PRやissueを立ててもらったときに忙しかったりPCが開けない状態だと返信できないこともある。返信できないときは申し訳ないと思っている

きちんとメンテナンスされているOSSだと、issueに色々ラベルが付いているのでこれを参考にするのも良いかなと思いました。
私も何度かOSSコントリビュートしましたが、以下のようなラベルが付いているものが取り組みやすいかなと思いました。

  • good first issue
  • help wanted
  • PR welcome
  • document

まとめ

OSS活動への参加となると、知らない人と連絡を取り合うわけですしなんとなく敷居の高さを感じておりましたが、むしろOSSメンテナーの方々はどんな小さなことでも歓迎という感じがしました。
私もちょっと躊躇しがちなところがこれまでありましたが、普段の開発でOSSには随分とお世話になっていますので、できることから貢献していきたいと思いました!

OSS活動に興味がある方はこちらの記事も参考にどうぞ。
https://zenn.dev/horitaka/articles/vue-fes-japan-2022-oss-vuetify

GitHubで編集を提案

Discussion

ログインするとコメントできます