Vim にコントリビュートしたい (ダウンロードでリンク有効) / How to contribute to the Vim

Vim にコントリビュートしたいゴリラ.vim #5 on 2019/6/13

自己紹介西畑, m-nishi Vim 歴 1 年半横浜で組み込み屋をやっていますプラグインよりも Vim
本体のほうが好き Twitter mnishz0 GitHub mnishz

概要ターゲット • Vim が好きで「何かコントリビュートしてみたい」と思っている人内容 • どんな方法があるのか • 何ができるのかを自分なりに探ってきた道のり
• 取り立てて「〇〇を実装したい！」という明確なモチベーションはなかった • もし Vim のコミットログに名前が載ったら。。という不純な動機も

1 % "ドキュメント編" 2 "実装編"

Lv. 1: 日本語ヘルプの修正 vim-jp 運営のおなじみ日本語ヘルプ誤字脱字や誤りを発見してレポートオンライン版は常に最新なので、こちらを参照してみてください

Lv. 1: 日本語ヘルプの修正やり方(動画) オンラインヘルプの編集ボタンから

Lv. 1: 日本語ヘルプの修正改行等の細かい作法はあるが、とりあえず気にしなくて OK • 「ですます」不統一 • インデントずれ •
等の細かい修正でも番外編 vim-jp/vimdoc-ja をプラグインのように追加すればローカルで最新のヘルプを参照することができる

Lv. 2: 本家ヘルプの日本語への翻訳翻訳作業リポジトリで有志による翻訳作業をやっています https://github.com/vim-jp/vimdoc-ja-working 本家ヘルプが更新されたタイミングで、日本語への翻訳を実施過去 1 年間では 16
コミット / 月

Lv. 2: 本家ヘルプの日本語への翻訳やり方 Wiki に詳しい作業手順や手引きが書いてあるファイルの翻訳に着手するときは #207
で宣言しておくと他の人と作業が被らなくていいです

Lv. 3: 本家ヘルプの修正 vim/runtime/doc で管理されている本家ヘルプの誤字脱字、誤りの修正本家に直接 PR を送っても問題はありませんが、vim-jp で内容
をまとめている (#1172) のでそこに送るのがいいと思います項目の棚卸を行うと、ヘルプの更新に伴って発生した抜け漏れが見つかることがある

1 "ドキュメント編" 2 % "実装編"

Lv. 4: Issue の投稿バグの報告や、実装の要望 vim-jp https://github.com/vim-jp/issues/issues vim-dev https://groups.google.com/forum/#!forum/vim_dev https://github.com/vim/vim/issues
vim-jp の方々はびっくりするくらい優しいので、まずは Slack の question チャンネルで尋ねてみるのもいいと思います

Lv. 4: Issue の投稿問題の切り分けや再現手順が適切にできていれば bug reporter として名前が載るコツ •
いろんな機能をいろんな条件で試してみる • 新機能にはバグが多い • とりあえず毎日 fetch して log を眺めて build してみる

Lv. 5: Bug Fix や機能の実装

Lv. 5: Bug Fix や機能の実装急にハードル高いそもそもこれができる人は言われなくてもやっているそこで。。

Lv. 4.5:テストを書く Bug Fix や実装はつよい人たちがいるので、ニッチ市場を攻める src ディレクトリで `make test`
を実行テストに関する解説記事も書いたりしてます

Lv. 4.5:テストを書くテストされていないコードを探して、テスト用 Vim script を書く • コマンド
• 組み込み関数 • オプション src/evalfunc.c のテストを書いて PR 投げました結果。。 Codecov src/evalfunc.c:f_cindent()

Lv. 4.5:テストを書く未テストだった 35 行が新たにテストされるように無事 merge されました！

思ったこと名前が載ったら嬉しいいろいろやっているだけでも割と楽しい翻訳やテストによる Vim 基礎力の向上一朝一夕では難しいが、長く続けていると自分しか気付いていないことや自分でもできることが見つかる

今後とか Bug fix を 2 件入れることができた新機能の実装もやってみたい colorscheme プレビュー「機能を入れたいだけの人」にならないように
みなさんも興味があれば是非やってみてください

Vim にコントリビュートしたい (ダウンロードでリンク有効) / How to contri...

Vim にコントリビュートしたい (ダウンロードでリンク有効) / How to contribute to the Vim

m-nishi

Other Decks in Technology

Featured

Transcript

Vim にコントリビュートしたいゴリラ.vim #5 on 2019/6/13

自己紹介西畑, m-nishi Vim 歴 1 年半横浜で組み込み屋をやっていますプラグインよりも Vim

概要ターゲット • Vim が好きで「何かコントリビュートしてみたい」と思っている人内容 • どんな方法があるのか • 何ができるのかを自分なりに探ってきた道のり

1 % "ドキュメント編" 2 "実装編"

Lv. 1: 日本語ヘルプの修正 vim-jp 運営のおなじみ日本語ヘルプ誤字脱字や誤りを発見してレポートオンライン版は常に最新なので、こちらを参照してみてください

Lv. 1: 日本語ヘルプの修正やり方(動画) オンラインヘルプの編集ボタンから

Lv. 1: 日本語ヘルプの修正改行等の細かい作法はあるが、とりあえず気にしなくて OK • 「ですます」不統一 • インデントずれ •

Lv. 2: 本家ヘルプの日本語への翻訳翻訳作業リポジトリで有志による翻訳作業をやっています https://github.com/vim-jp/vimdoc-ja-working 本家ヘルプが更新されたタイミングで、日本語への翻訳を実施過去 1 年間では 16

Lv. 2: 本家ヘルプの日本語への翻訳やり方 Wiki に詳しい作業手順や手引きが書いてあるファイルの翻訳に着手するときは #207

Lv. 3: 本家ヘルプの修正 vim/runtime/doc で管理されている本家ヘルプの誤字脱字、誤りの修正本家に直接 PR を送っても問題はありませんが、vim-jp で内容

1 "ドキュメント編" 2 % "実装編"

Lv. 4: Issue の投稿バグの報告や、実装の要望 vim-jp https://github.com/vim-jp/issues/issues vim-dev https://groups.google.com/forum/#!forum/vim_dev https://github.com/vim/vim/issues

Lv. 4: Issue の投稿問題の切り分けや再現手順が適切にできていれば bug reporter として名前が載るコツ •

Lv. 5: Bug Fix や機能の実装

Lv. 5: Bug Fix や機能の実装急にハードル高いそもそもこれができる人は言われなくてもやっているそこで。。

Lv. 4.5:テストを書く Bug Fix や実装はつよい人たちがいるので、ニッチ市場を攻める src ディレクトリで `make test`

Lv. 4.5:テストを書くテストされていないコードを探して、テスト用 Vim script を書く • コマンド

Lv. 4.5:テストを書く未テストだった 35 行が新たにテストされるように無事 merge されました！

思ったこと名前が載ったら嬉しいいろいろやっているだけでも割と楽しい翻訳やテストによる Vim 基礎力の向上一朝一夕では難しいが、長く続けていると自分しか気付いていないことや自分でもできることが見つかる

今後とか Bug fix を 2 件入れることができた新機能の実装もやってみたい colorscheme プレビュー「機能を入れたいだけの人」にならないように

:qa!