revanced patches template

Продолжение наследия Ванс

? Шаблон реконструкции патчей

Репозиторий шаблона для реконцентрированных патчей.

❓ о

Это шаблон для создания нового репозитория Revanced Patches.
Репозиторий может иметь несколько патчей, и патчи из других репозиториев могут использоваться вместе.

Для примера репозитория см. Реконструированные патчи.

Начните

Чтобы начать использовать этот шаблон, выполните следующие действия:

1. Создайте новый репозиторий, используя этот шаблон
2. Установите файл build.gradle.kts (в частности, группу проекта и ABE)
3. Обновление зависимостей в файле libs.versions.toml
4. Создайте пас-фразовый мастер GPG и подки
   1. Добавьте закрытый ключ в качестве секрета с именем gpg_private_key в ваш репозиторий
   2. Добавьте пасфразу в качестве секретной с именем gpg_passphrase в ваш репозиторий
   3. Добавьте отпечаток пальца подказки GPG в качестве секретного названия GPG_FingerPrint в ваш репозиторий
5. Установите файл readme.md ¹ (например, заголовок, описание, лицензия, сводка исправлений, которые включены в репозиторий), шаблоны выпуска ² и Руководство 3 взноса ³

? Теперь вы готовы начать создавать патчи!

? Дополнительные шаги

Вы также можете добавить следующие вещи в хранилище:

• Документация API, если вы хотите опубликовать свои исправления в виде библиотеки

? ‍ Использование

Чтобы разработать и выпустить реконструкционные патчи, используя этот шаблон, необходимо учитывать некоторые вещи:

• Разработка начинается в филиалах. Как только филиал будет готова, она раздавлена ​​и объединена в филиал dev
• Ветвь dev объединен в main ветку, как только она будет готова к выпуску
• Семантическое управление версиями используется для реконструкции версий. Ответственные патчи имеют публичный API для других патчей для использования
• Семантические сообщения коммита используются для коммитов
• Коммитами в dev Branch и main Branch автоматически выпускаются через рабочую процесс release.yml, который также отвечает за создание изменений и обновление версии реконструкционных патчей. Это запускается путем толчка к dev или main ветви. Рабочий процесс использует задачу publish , чтобы опубликовать выпуск реконструкции патчей
• Задача buildAndroid используется для создания реконструкционных патчей, чтобы ее можно было использовать на Android. Задача publish зависит от задачи buildAndroid , поэтому она будет автоматически запускать при публикации выпуска.

Все остальное

? Внося

Спасибо за рассмотрение внесения вклад в шаблон реконструкции патчей.
Вы можете найти рекомендации взносов здесь.

Здание

Чтобы создать шаблон реконструкции патчей, вы можете следить за реконструкцией документации.

Лицензия

Шаблон реконструкции патчей лицензирован по лицензии GPLV3. Пожалуйста, смотрите файл лицензии для получения дополнительной информации. TL; DR Вы можете копировать, распространять и изменять шаблон реконструкции патчей, если вы отслеживаете изменения/даты в исходных файлах. Любые модификации шаблона реконцентрированных исправлений также должны быть доступны в GPL, а также инструкции по сборке и установке.

Сноски

1. Пример readme.md -файл ↩

2. Пример шаблонов выпуска ↩

3. Пример руководящих принципов ↩