
ESLintのルールをコメントで抑制するOSSに貢献してみた
この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。
- 自分のスキルの証明になる
- 知見が増える
- 社会貢献できる
- エンジニアの知り合いが出来るかも
GitHubでOSSに参加する方法
慣れてきたらもう少し難易度を上げて、issueにある不具合や、自分が見つけた不具合を修正したりしましょう。場合によっては自分でissueを立てて方針など相談する必要があります。あまり活動が行われていないリポジトリだと、PRを出しても放置される可能性があるので、気をつけましょう。
git clone [url]
cd [project name]
git checkout -b [branch name]
本家リポジトリの追加(オプション)
まず、ここまでで三つのリポジトリが出てきました。
- 本家リポジトリ(fork元のリポジトリ)
- 自分のリモートリポジトリ(forkして出来たリポジトリ)
- ローカルリポジトリ(自分のリモートリポジトリのclone)
これまでリモートリポジトリの変更分をローカルに反映させる場合は、
git pull origin main
を実行しましたが、このコマンドを実行しても本家リポジトリの変更分まではローカルに反映されません。originに登録されているのは、自分のリモートリポジトリであるためです。
そこで、ローカルリポジトリに本家リポジトリも登録します。自分のリモートリポジトリは、「origin」で登録されていますが、本家リポジトリは「upstream」として登録します。
git remote add upstream git://github.com/DQNEO/Renshu.git
その後、本家リポジトリの情報をローカルリポジトリに反映します。またブランチの一覧も表示してみます。
git fetch upstream
git branch -a
すると以下のような名前で、本家リポジトリのブランチ名が表示されました。
本家リポジトリの変更分をローカルに反映させます。
git pull upstream main
PR(プルリクエスト)作成
自分が貢献したOSS「eslint-disable-commenter」
「eslint-disable-commenter」の使い方
npm i -D eslint-disable-commenter
npx eslint-disable-commenter --config .eslintrc.json index.ts

上の画像の中でコメントタイプのオプションがあります。今回このオプションの開発に自分が貢献しました。
-t, --comment-type [type]
コメントタイプを使うと、挿入するコメントの仕方をファイル単位か、行単位のどちらか指定することができます。