vim-jp/vimdoc-jaにコントリビューションした話

  • 19
    いいね
  • 0
    コメント

この記事は Vim Advent Calendar 2016 9日目の記事です。
vim-jp organization

この記事で言いたいこと

以上です。以下はどうしてvimdoc-jaに翻訳参加することになったのか、やってみてどうだったか書いていきたいと思います。

やったこと

  • 未翻訳部分を翻訳。
    • repeat.jax
    • eval.jax(進行中)
  • 英語版と日本語版とのバージョンが不一致な箇所修正、更新分を翻訳
    • autocmd.jax
    • cmdline.jax
    • filetype.jax

動機

  • そういえば最新のVimではpackagesというプラグイン管理の仕組みが導入されたらしいので試してみよう。
  • まずはヘルプ見よう。:help packages…ってあれ、一部未翻訳な箇所がある。
  • そういえば @kaoriya さんが VimConf2016 で「翻訳作業に是非参加を!」っていってたしやってみるか。

と、ふわっとした感じでやってみました。

前提条件

  • 筆者の英語力はこんな感じです。特別英語が得意というわけではありません。
    • 英語で書かれた記事やドキュメントをGoogle翻訳や辞書を使いつつ読む
    • かんたんなEnglishで会話できる

実際の手順

  • やり方は Workflow に書いてあるのでその通りに。
  • Guide に翻訳をするに当たっての注意点が書いてあるのでPRを投げる前にしっかり確認すること。
    • autofmt の設定は最初にやったほうがいい。
    • koron/nvcheck を使ってローカルでチェックしておくとTravisCIさんに怒られなくて済む。
  • PR投げた後はvim-jpの方々から随時レビューが入るので、指摘事項を反映しコミット。
  • Merged!

やってみてどうだったか。

  • 気になるものはやってみようという意識が高まった。

    • 今まで「誰かがやるだろう」とか「また今度でいいや」と後回しにしていたのに、「ちょっとやってみるか」とトライすることが多くなってきた。
  • Vim、Git(GitHub)の理解が深まった。

    • 「Vimのhelpってこうなっているんだ。」
    • 「Gitのブランチってそういえばあんまり使ってなかった。」
    • 「GitHubのレビュー機能ってこう使うのか。」
  • vim-jp organizationのバッチをGETした。

    • これで自分もPRをMergeできるよ!(けどまだそこまでレビューできる自信はないのでいずれ)

翻訳についてもそうですが、一人でやってるとmasterでガシガシコミットしていく形式でやってた自分もGitやGitHubについても理解を深められたのは嬉しい誤算でした。

実はやる前は「適当な訳を投げるな!」とかフルボッコにされるのではないかと不安な気持ちもありましたが、「まあ何かあったらその時考えればいいや。」と自分に言い聞かせてやってみました。
完璧を目指すよりまず終わらせろ Done is better than perfect.とマーク・ザッカーバーグ氏も言ってますしね。
(実際にはフルボッコなんてもちろんないですよ!)

終わりに

  • 翻訳作業にぜひ参加を!
    • 「どこから手をつけたらいいかわからない」という方は IssuesProjects に上がっているところから手を付けていくのがいいかも。
    • 2016/12/09現在だと、eval.jax の未訳文を翻訳する・Issue #48 が進行中なので、少しずつ手を広げていくのがいいかも。
この投稿は Vim Advent Calendar 20169日目の記事です。