タイポから始めるドキュメントコントリビューティング活動

2022.08.31

こんにちは!AWS事業本部コンサルティング部のたかくに(@takakuni_)です。

今回は、「タイポから始めるドキュメントコントリビューティング活動」と題してポエムブログになります。

私事ながら、2022年の夏はSnykをいう製品をたくさん触りました。

ブログの数では10本以上書いたわけですが、裏でSnykのドキュメントに対してもコントリビューティングを行っていました。

今回は、活動を通じて学んだことやモチベーションを保って継続できた理由を言語化できればと思います。

学んだこと

Gitのコマンドが少しわかるようになった

恥ずかしながら、クラスメソッドに入社前はGitをほとんど使ったことなくブランチの切り方、プルリクエストの方法のお作法も全然わかりませんでした。

入社後もコードを書く人が私のみの場合、付け焼き刃で覚えた次のコマンドを使い倒していたので、Gitへの理解がまだまだ浅いなと痛感していました。

git add .
git commit -m "「追加しました。」的なメッセージ"
git push

対して、今回のような社外のリポジトリに対してプルリクエストを送る場合、そんな乱暴なお作法は話になりません。リポジトリのフォークの方法、ブランチの切り方、PRの書き方など、視野を少しばかりではありますが広げることができるようになりました。

ドキュメントをもっと読み込むようになった

フィードバック(コントリビューティング)してやるぞ!といった意気込みでドキュメントを読むと、「他のページだとAAAと記載があったけど、今回はBBBも書いてあるな」のような各ページ間の相関関係をより気にするようになりました。

「どちらが正しいのだろう」と疑問に思い、検証、ブログ化 or コントリビューティングの流れが作れて、私にとってはより理解が深まる成功体験だったと思いました。

英語力向上?

ドキュメントが記載されている言語によりますが、Snykの場合は英語で記載されているため英語での読解、PR作成が求められました。

活動を通じて私の場合、「capitalize」を新しい単語として学ぶことができました。

モチベーションを保てた理由

更新頻度が高いリポジトリ

Snykドキュメントの場合、更新頻度高めなリポジトリなのが好機だったのかもしれません。

私の作成したPRを少なからず、数日以内に確認しコメントくれるのはモチベーションを保てた理由だと思いました。また、マージ後のアップデートされたドキュメントをみると「やってやったぞ!」とワクワクするのもたまりませんでした。

ランキング形式がたまらない

Githubの機能の1つで、コントリビューティングをランキング形式で確認できます。

私は2022年8月現在、16位なので「一桁以内に入ってやるんだ」と野望を抱きながらモチベーションを保てています。タイポでも1コミットでカウントされるので、どんどんタイポも技術的な部分も見つけたいなと思いました。

まとめ

以上、「タイポから始めるドキュメントコントリビューティング活動」でした。

私のコントリビューティングはほとんどがタイポや表記揺れですが、今後は技術的に誤った部分などもどんどんプルリクエスト出来たらなと思います。

以上、AWS事業本部コンサルティング部のたかくに(@takakuni_)でした!