はじめに
本記事はOSS初心者(というかはじめて)の私がVue.jsでコントリビューターになるまでのお話です。
(※2020/12/21現在、PRを出している最中なのでm、厳密にはコントリビューターではありません。笑)
きっかけ
単純に英語を勉強したいな、と思っていたのと、OSSってコードのメンテナンスや機能開発以外にも道があるので、ゴリゴリにコードかけなくてもOSS参加できるよ!ということと、ゴリゴリにコード書くだけがエンジニアの価値じゃないよ!ということを伝えたかったのでチャレンジしてみました。
何をやったか
平たくいうと、Vue.jsのドキュメントの翻訳をやりました!
Vue.jsは2020年9月にVue 3.0.0がリリースされ、Vue.jsのコミュニティ内(Slack内)で翻訳されてないものがある、ということだったので覗いてみたところ、分量も多くなく、Google 翻訳やDeepLなども使って良いということだったので、チャレンジしてみました。
OSSコントリビュートまでの手順
言語やライブラリ、フレームワークによって違うと思いますがVue.jsの場合はこちらに記載されているような手順で進みます。
大雑把にかくと
- GitHubのリポジトリをフォークする
- フォークしたリポジトリからブランチを生やしてコツコツとコミットを積んでゆく
- できた!と思ったらプルリクを出す
- レビューしていただく
- OKならばマージされ、無事にコントリビューターに🎉
いやあ、意外と簡単ですね!こんな僕でもOSSコントリビューターになれるなんて!
(※2020年12月21日時点ではまだコントリビューターになっていないけど)
フォークした後の開発環境構築
- 今回は普段開発でも触ったことあるVue.jsの開発環境構築だったので、そんなに手間取ることはなく
npm install
npm run dev
のコマンドを叩いてlocalhost:8080にアクセスすると
こんな感じの画面が出てきてくれます。Vue.jsのドキュメント画面ですね。(これはVue2系のものをキャプチャしています)
いざ、OSSコントリビュート!
- まずはサクサクと1文ずつDeepLとGoogle翻訳に入れていきます。
- 次に、翻訳された文章の意味を自分が理解できるかを確認します。
- 理解できない場合、意味がわかりにくい場合は、その箇所に使われている英語の構文や単語をもう少し掘り下げて調べます。
- その作業を終えて、(自分として)理解しやすい文になったな、と思ったら次の文にいきます
- 以後、上記の手順を繰り返し…
※書いているファイルはmarkdownなので、.mdファイルの記法は知っておくと読みやすいかもしれません。(エンジニアなら誰でもわかると思うけど…)
翻訳している時の様子はこんな感じ
- 全てができたら、 元のリポジトリに対してプルリクエストを出します。
- レビュアーがレビューしてくださるので、修正を積み重ねていきます。
- 無事にLGTMが出たら晴れてコントリビューターです🎉
つまづいたポイント
- jp.vue.js.orgとja.vue.js.orgがあって、最初間違えてフォークしてた…
- 日本語のlintがあるので、そこでめっちゃ引っかかった(半角と全角の文字の間には半角スペースを開けるなど)
所感
意外とあっさりPRを出すところまでいけました。
追って、コントリビューターになったら記事を更新したいと思います!