対象OSSの理解
貢献したい OSS がどういったものか,調べてみましょう
貢献したいOSSを調査することで,「どのようなルールで」「どのような温度感で」開発されているか知ることができます.
ルールや温度感を理解した上で貢献することで,トラブルを回避しスムーズな活動ができます.
このページでは,最低限の確認事項をピックアップします.
確認事項
例えば以下の事項について調査すると良いでしょう
- Issue や PullRequest の作成ルール
- 決まったフォーマットで作成する必要があるか
- どの言語で作成するべきか(日本語 or 英語)
- コーディングのルール
- Lint 等のフォーマッタを利用する必要があるか
- どのような命名規則が決められているか
- etc ...
これらについては以下のファイルやページを確認することで調査することができます.
確認したいファイル
ここでは例として https://github.com/takanakahiko/slack-emoji-meister を参考に説明します
README.md
リポジトリの説明として一番に挙げられるファイルです.
GitHubであれば,リポジトリのトップページに掲載されている文書です.
https://github.com/takanakahiko/slack-emoji-meister/blob/master/README.md
CONTRIBUTING.md
リポジトリへの貢献方法や,そのルールが書いているファイルです.
リポジトリ直下か, .github ディレクトリ内に配置されている場合が多いです.
Issue や PullRequest を作成する前に必ず確認しましょう.
https://github.com/takanakahiko/slack-emoji-meister/blob/master/.github/CONTRIBUTING.md
確認したいページ
ここでは例として https://github.com/takanakahiko/slack-emoji-meister を参考に説明します
過去の Issue
Issue や PullRequest を作成する前に,「すでに話したことのある話題であるか」確認したほうが良いでしょう.
https://github.com/takanakahiko/slack-emoji-meister/issues?q=is%3Aissue
ドキュメントや公式ページ
ドキュメントや公式ページに別途案内がある場合があります