感想
先日 mise にコントリビュートできました。ドキュメントの修正だけなのでたいしたことはやっていないのですが、初の OSS コントリビュートなので記事にしておきます。
作成したPR
リリースノートに名前が載るのもうれしい。 OSS としてコントリビュータを増やすためにも、こういった達成感を感じられる仕組みがあることは大事なんだろうなと思いました。
リリースノート
修正箇所を見つけた流れ
- mise のバックエンド機能について記事を書いていた。
- 公式ドキュメントを読んでいたら、ページごとに説明が異なっていることに気づく。
- 一覧ページには experimental 表記があるが、Cargo と NPM の個別のページには表記がない。
- あれれ、おかしいぞ。
- 実際にソースコード読んでみると、Cargo と NPM も experimental ではなさそう。
- PR 作るか。
やったこと
- Conventional Commit に従ってコミットメッセージを書く。
- 自分は 10行のVim scriptで実現する快適?Conventional Commits の設定を入れていて普段から使っているので問題なしでした。
- PR のテンプレートがないか確認する。
- テンプレートがなかったので他の人の PR を見る。
- Doc 系の PR は修正内容を一言で書いてある程度のものが多かったので、それに倣いました。
- 日本語でコミットメッセージと PR の説明を書く。
- 自力で英語に翻訳する。
- DeepL で英語 -> 日本語に翻訳してみて違和感がないか確認する。
- ChatGPT で日本語と英語を入れて「これで日英の翻訳ができていますか」「失礼な表現ではないですか」「より良い表現はありますか」など確認してみる。
- PR 作成
英語を書くことに慣れていないのと、失礼な表現を使ってしまうのが心配だったので、DeepL と ChatGPT を使って念入りに確認しました。
おわりに
「 OSS コントリビュートしたいけどどうやったら良いかわからん」という人の参考になれば幸いです。
またこれを皮切りにドキュメントだけでなくソースコードにもコントリビュートしていきたいです。