ProtonVPN pour Android

Copyright (c) 2019 Proton AG

Téléchargement

Instructions de compilation

• Installez sdk, ndk, cmake, swig
• Clonez ce dépôt
• ./gradlew assembleProductionVanillaOpenSourceDebug ou ouvrez et compilez dans Android Studio

Compilation de la version release

Pour effectuer une compilation release, des clés de signature doivent être fournies :

• ./gradlew assembleProductionVanillaOpenSourceRelease -PkeyStoreFilePath=<keystore> -PkeyStoreKeyAlias=<alias> -PkeyStorePassword=<pass> -PkeyStoreKeyPassword=<key-pass>

Style de code

Le projet utilise le style de code convenu ProtonStyle.xml pour Java. Importez-le dans Android Studio via File>>Settings>>Editor>>Code style>>Import Scheme Pour le style de code de Kotlin, nous utilisons ktlint avec les règles par défaut

Contribuer

Si vous souhaitez contribuer, veuillez garder à l'esprit les règles suivantes :

• Essayez de vous en tenir au style de code et aux conventions de nommage existants du projet
• La base de code est principalement écrite en Java, mais nous passons à Kotlin, donc tout nouveau code devrait être écrit en Kotlin lorsque c'est possible
• Notre pile technologique préférée est Kotlin, MVVM, data-binding et coroutines, donc toute nouvelle fonctionnalité ou refactorisation importante doit se conformer à cette pile technologique préférée
• Après avoir ajouté/mis à jour des dépendances open source, exécutez gradlew updateLicensesJson pour mettre à jour les attributions.

En interne, notre CI vérifie automatiquement toutes les pull requests pour les problèmes de style de code, et exécute nos tests. Cependant, vous pouvez également les exécuter localement.

gradlew checkstyle
gradlew detekt
gradlew test
gradlew androidTest

En apportant une contribution à ce projet, vous acceptez ce qui suit :

1. Je cède à Proton AG tous les droits d'auteur liés à la contribution ;
2. Je certifie que la contribution a été entièrement créée par moi ;
3. Je comprends et j'accepte que ce projet et la contribution soient publics et qu'un enregistrement de la contribution (y compris toutes les informations personnelles que je soumets avec elle) soit conservé indéfiniment et puisse être redistribué avec ce projet ou la ou les licences open source concernées.

Signature

Toutes nos versions (sauf F-Droid) seront signées avec la même clé. Empreinte SHA256 du certificat de signature

ch.protonvpn.android
DC:C9:43:9E:C1:A6:C6:A8:D0:20:3F:34:23:EE:42:BC:C8:B9:70:62:8E:53:CB:73:A0:39:3F:39:8D:D5:B8:53

Gestion des versions

• La version correspond au format : [major][minor][patch][hotfix]

Licence

Le code et les fichiers de données de cette distribution sont sous licence GPLv3 telle que publiée par la Free Software Foundation. Voir https://www.gnu.org/licenses/ pour une copie de cette licence.

Copyright (c) 2019 Proton AG