Contribution

ZennのOSSにコントリビュートする方法を説明します。

Issue を作成する

Zennでは機能リクエストやバグのトラッキングに zenn/zenn-community リポジトリの Issue を利用しています。

あなたが機能リクエストやバグ報告をする場合は、どのツールやライブラリに対する内容であっても zenn/zenn-community リポジトリに Issue を作成してください。ただし、セキュリティに関する問題などパブリックにすることで問題が発生する可能性のあるものは、Zennのお問い合わせフォームから連絡してください。

機能リクエストの場合

作成された Issue はZennの開発チームが内容を確認し、提案を受け入れるかどうかを判断します。開発チームがコンテキストを理解できるよう、Issue Templateに従いできるだけ詳しく内容を記載してください。

大まかな受け入れの基準は、Zennとしての方針に沿っていること、多くのユーザーにメリットがあること、持続してメンテナンスが可能であること、互換性が保たれること、などです。（この他に、各ツール・ライブラリごとに細かい方針がある場合があります。）限定的なユースケースや環境に依存するリクエストは受け入れられない可能性が高いです。

既存のIssueの解決を手伝う

既存の Issue にコメントすることで Issue の解決を手伝うこともできます。技術的な問題解決の提案や、バグの再現情報の提供など、Issue を解決するために必要な情報を提供していただけるだけでも大変ありがたいです。

Pull Request を作成する

Zennの開発チームが受け入れた Issue について、実装を行い Pull Request を作成することができます。Pull Request の受け入れ条件は、各ツール・ライブラリの開発ガイドを参照してください。

その他、テストコードの追加、リファクタリング、ライブラリのアップデート、ドキュメントの修正、などの Pull Request も歓迎します。これらは Issue を作成する必要はありませんが、変更が大きい場合は受け入れられない可能性もありますので、心配な場合は Issue を作成してください。