OSS公開の流れ
さあ!OSSを公開してみましょう!
さあ!OSSを公開してみましょう!
OSSを公開するにあたって、役に立つ情報をまとめました
必須事項
必須事項
関係してしまう事業(サービス)や上司・同僚などに「OSS化しますわ」と宣言だけしておきましょう。
リポジトリのOSS化
リポジトリのOSS化
以下の手順でOSS化しましょう
- ソースコードから公開してはいけない情報(アクセストークン等)を取り除く
- パブリックなリポジトリで公開する
- ライセンスの設定
- 貢献を受け付けている旨をREADME等に記載する
より良いOSSにするため
より良いOSSにするため
必須ではありませんが、以下のことをするといいでしょう
- README等のドキュメントを英語化する(国際化)
- PullRequest や Issue のテンプレートを作成する
- CI 等で PullRequest のテストを自動化する
- 貢献方法をREADME等に記載する
Maintainer が行うこと
Maintainer が行うこと
PullRequest のレビュー
PullRequest のレビュー
PullRequest が作成された際に、そのレビューを行います。
問題なければマージ、そうでなければ変更依頼をしましょう。
Issue等の管理
Issue等の管理
不要なIssueの削除や、議論への参加を行います。
メンテナが議論へ参加することで、リポジトリの方針を Contributor へ共有できるため、よりよいOSSになるでしょう。
その他
その他
- Maintainerがリポジトリに直接コミットする場合もあります。(方針によります)
- Maintainer 自ら PullRequest を発行し、マージする(セルフマージ)リポジトリも多いようです。(方針によります)
- メンテナ、レビュワーの任命
- CIの初期設定等、リポジトリの所持者が作業を行う必要があるタスク