revanced patches template

Continuando o legado de vanja

? Modelo de patches Retanced

Repositório de modelos para patches retancedores.

❓ Sobre

Este é um modelo para criar um novo repositório de patches Retanced.
O repositório pode ter vários patches e patches de outros repositórios podem ser usados ​​juntos.

Para um exemplo de repositório, consulte Patches Retanced.

Comece

Para começar a usar este modelo, siga estas etapas:

1. Crie um novo repositório usando este modelo
2. Configure o arquivo build.gradle.kts (especificamente o grupo do projeto e o sobre)
3. Atualize as dependências no arquivo libs.versions.toml
4. Crie uma chave mestre de GPG em massa de passagem e subchave
   1. Adicione a chave privada como um segredo chamado gpg_private_key ao seu repositório
   2. Adicione a senha como um segredo chamado gpg_passphrase ao seu repositório
   3. Adicione a impressão digital do GPG Subkey como um segredo chamado gpg_fingerprint ao seu repositório
5. Configure o arquivo ¹ readme.md (por exemplo, título, descrição, licença, resumo dos patches incluídos no repositório), os modelos de emissão ² e as diretrizes de contribuição ³

? Agora você está pronto para começar a criar patches!

? Etapas opcionais

Você também pode adicionar as seguintes coisas ao repositório:

• Documentação da API, se você quiser publicar seus patches como uma biblioteca

? ‍ Uso

Para desenvolver e lançar patches retancedores usando este modelo, algumas coisas precisam ser consideradas:

• O desenvolvimento começa em filiais de recursos. Depois que uma filial de recursos está pronta, ela é esmagada e fundida no ramo dev
• A filial dev é fundida no ramo main quando estiver pronto para ser lançado
• O versão semântica é usada para versões retancinhas. Patches Retanced têm uma API pública para outros patches usarem
• Mensagens semânticas de compromisso são usadas para compromissos
• As confirmações no ramo dev e na ramificação main são lançadas automaticamente através do fluxo de trabalho Release.yml, que também é responsável por gerar o Changelog e atualizar a versão dos patches Retanced. É desencadeado empurrando para o dev ou ramo main . O fluxo de trabalho usa a tarefa publish para publicar o lançamento de patches Revanced
• A tarefa buildAndroid é usada para criar patches Retanced para que possa ser usado no Android. A tarefa publish depende da tarefa buildAndroid , por isso será executada automaticamente ao publicar uma versão.

Tudo o mais

? Contribuindo

Obrigado por considerar contribuir para o modelo de patches retanced.
Você pode encontrar as diretrizes de contribuição aqui.

Prédio

Para criar o modelo de patches retancedes, você pode acompanhar a documentação Retanced.

Licença

O modelo de patches Retanced está licenciado sob a licença GPLV3. Consulte o arquivo de licença para obter mais informações. TL; DR Você pode copiar, distribuir e modificar o modelo de patches Retanced, desde que rastreie alterações/datas nos arquivos de origem. Quaisquer modificações no modelo de patches revancetadas também devem ser disponibilizadas no GPL, juntamente com as instruções de compilação e instalação.

Notas de rodapé

1. Exemplo de arquivo readme.md ↩

2. Exemplo de modelos de problema ↩

3. Exemplo de diretrizes de contribuição ↩