revanced patches template

Vancedの遺産を継続します

？改装されたパッチテンプレート

改訂パッチ用のテンプレートリポジトリ。

❓について

これは、新しい改装されたパッチリポジトリを作成するためのテンプレートです。
リポジトリには複数のパッチがあり、他のリポジトリのパッチを一緒に使用できます。

リポジトリの例については、Revanced Patchesを参照してください。

始めましょう

このテンプレートの使用を開始するには、次の手順に従ってください。

1. このテンプレートを使用して新しいリポジトリを作成します
2. build.gradle.ktsファイル（具体的には、プロジェクトのグループ、およびabout）をセットアップします
3. libs.versions.tomlファイルの依存関係を更新します
4. Pass-Phrased GPG Master KeyとSubkeyを作成します
   1. 秘密鍵をgpg_private_keyという名前の秘密としてリポジトリに追加します
   2. gpg_passphraseという名前の秘密としてpassphraseをリポジトリに追加する
   3. gpg_fingerprintという名前の秘密としてgpgサブキーの指紋をリポジトリに追加する
5. readme.mdファイル¹ （例、タイトル、説明、ライセンス、リポジトリに含まれるパッチの概要）、問題テンプレート² 、貢献ガイドライン³

？パッチの作成を開始する準備ができました！

？オプションの手順

また、次のものをリポジトリに追加することもできます。

• パッチをライブラリとして公開する場合は、APIドキュメント

？使用法

このテンプレートを使用して改装されたパッチを開発およびリリースするには、いくつかのことを考慮する必要があります。

• 開発は機能ブランチで始まります。機能ブランチの準備ができたら、それは押しつぶされ、 devブランチに統合されます
• devブランチは、リリースの準備ができたら、 mainブランチにマージされます
• セマンティックバージョンは、バージョンの改訂パッチに使用されます。改装されたパッチには、他のパッチを使用するためのパブリックAPIがあります
• セマンティックコミットメッセージはコミットに使用されます
• devブランチとmainブランチでのコミットは、Release.ymlワークフローを介して自動的にリリースされます。 devまたはmainブランチにプッシュすることでトリガーされます。ワークフローは、 publishタスクを使用して、改装されたパッチのリリースを公開します
• buildAndroidタスクは、Androidで使用できるように改装されたパッチを構築するために使用されます。 publishタスクはbuildAndroidタスクに依存するため、リリースを公開するときに自動的に実行されます。

他のすべて

？貢献

Revanced Patchesテンプレートへの貢献を検討していただきありがとうございます。
貢献ガイドラインはこちらで見つけることができます。

建物

Revanced Patchesテンプレートを作成するには、Revanced Documentationに従うことができます。

ライセンス

Revanced Patchesテンプレートは、GPLV3ライセンスの下でライセンスされています。詳細については、ライセンスファイルをご覧ください。 TL; DRソースファイルの変更/日付を追跡する限り、Revanced Patchesテンプレートをコピー、配布、変更できます。改装されたパッチテンプレートの変更は、Build＆Install命令とともに、GPLの下でも利用できるようにする必要があります。

脚注

1. readme.mdファイルの例

2. 例の問題テンプレート↩

3. 貢献ガイドラインの例