revanced patches template

Poursuivant l'héritage de Vanced

? Modèle de correctifs avides

Référentiel de modèles pour les correctifs avancés.

❓

Ceci est un modèle pour créer un nouveau référentiel de correctifs avalé.
Le référentiel peut avoir plusieurs correctifs et les correctifs d'autres référentiels peuvent être utilisés ensemble.

Pour un exemple de référentiel, voir les correctifs avancés.

Commencer

Pour commencer à utiliser ce modèle, suivez ces étapes:

1. Créer un nouveau référentiel à l'aide de ce modèle
2. Configurez le fichier build.gradle.kts (en particulier, le groupe du projet et le sujet)
3. Mettre à jour les dépendances dans le fichier libs.versions.toml
4. Créez une clé maître GPG en phrase Pass-Phrased
   1. Ajoutez la clé privée en tant que secret nommé gpg_private_key à votre référentiel
   2. Ajoutez la phrase de passe en tant que secret nommé GPG_PASSPHRASE à votre référentiel
   3. Ajoutez l'empreinte digitale de la sous-clé GPG comme secret nommé GPG_FingerPrint à votre référentiel
5. Configurez le fichier readme.md ¹ (par exemple, titre, description, licence, résumé des correctifs inclus dans le référentiel), les modèles de problème ² et les directives de contribution ³

? Vous êtes maintenant prêt à commencer à créer des correctifs!

? Étapes facultatives

Vous pouvez également ajouter les choses suivantes au référentiel:

• Documentation de l'API, si vous souhaitez publier vos correctifs en tant que bibliothèque

? ‍ Utilisation

Pour développer et publier des correctifs de randonnée en utilisant ce modèle, certaines choses doivent être prises en compte:

• Le développement commence dans les branches de fonctionnalités. Une fois qu'une branche de fonctionnalité est prête, elle est écrasée et fusionnée dans la branche dev
• La branche dev est fusionnée dans la branche main une fois qu'elle est prête pour la libération
• Le versioning sémantique est utilisé pour verser les correctifs aviés. Les correctifs de retour ont une API publique pour les autres correctifs à utiliser
• Les messages de validation sémantique sont utilisés pour les commits
• Commits on the dev Branch et main Branch sont automatiquement publiés via le workflow Release.yml, qui est également responsable de la génération du ChangeLog et de la mise à jour de la version des correctifs aviés. Il est déclenché en poussant vers le dev ou la branche main . Le workflow utilise la tâche publish pour publier la sortie de correctifs avancés
• La tâche buildAndroid est utilisée pour construire des correctifs aviés afin qu'il puisse être utilisé sur Android. La tâche publish dépend de la tâche buildAndroid , il sera donc exécuté automatiquement lors de la publication d'une version.

Tout le reste

? Contributif

Merci d'avoir envisagé de contribuer au modèle de correctifs avides.
Vous pouvez trouver les directives de contribution ici.

Bâtiment

Pour construire un modèle de correctifs avides, vous pouvez suivre la documentation avancée.

Licence

Le modèle de correctifs REVANCH est concédé sous licence GPLV3. Veuillez consulter le fichier de licence pour plus d'informations. TL; DR vous pouvez copier, distribuer et modifier le modèle de correctifs avides tant que vous suivez les modifications / dates dans les fichiers source. Toute modification du modèle de correctifs de ruine doit également être mise à disposition sous le GPL, ainsi que des instructions de construction et d'installation.

Notes de bas de page

1. Exemple de fichier readme.md ↩

2. Exemple de modèles de problème ↩

3. Exemples de directives de contribution ↩