ProtonVPN para Android

Copyright (c) 2019 Proton AG

Descarga

Instrucciones de compilación

• Instala sdk, ndk, cmake, swig
• Clona este repositorio
• ./gradlew assembleProductionVanillaOpenSourceDebug o abre y compila en Android Studio

Compilación de release

Para completar una compilación de release, deben proporcionarse las claves de firma:

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

Estilo de código

El proyecto utiliza el estilo de código acordado ProtonStyle.xml para Java. Impórtalo en Android Studio mediante File>>Settings>>Editor>>Code style>>Import Scheme Para el estilo de código de Kotlin usamos ktlint con las reglas predeterminadas

Contribuciones

Si deseas contribuir, ten en cuenta las siguientes reglas:

• Intenta mantener el estilo de código y las convenciones de nomenclatura existentes del proyecto
• La base de código está mayormente escrita en Java, pero estamos en transición a Kotlin, por lo que el código nuevo debe escribirse en Kotlin cuando sea posible
• Nuestra pila tecnológica preferida es Kotlin, MVVM, data-binding y coroutines, por lo que cualquier funcionalidad nueva o refactorización grande debe ajustarse a esta pila tecnológica preferida
• Después de añadir/actualizar dependencias de código abierto, ejecuta gradlew updateLicensesJson para actualizar las atribuciones.

Internamente, nuestro CI comprueba automáticamente todos los pull requests para detectar problemas de estilo de código y ejecuta nuestras pruebas. Sin embargo, también puedes ejecutarlas localmente.

gradlew checkstyle
gradlew detekt
gradlew test
gradlew androidTest

Al contribuir a este proyecto, aceptas lo siguiente:

1. Cedo cualquier derecho de autor relacionado con la contribución a Proton AG;
2. Certifico que la contribución fue creada en su totalidad por mí;
3. Entiendo y acepto que este proyecto y la contribución son públicos y que se mantiene un registro de la contribución (incluida toda la información personal que envío con ella) de forma indefinida y que puede redistribuirse con este proyecto o con las licencias de código abierto correspondientes.

Firma

Todas nuestras compilaciones (excepto F-droid) se firmarán con la misma clave. Huella digital SHA256 del certificado de firma

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

Versionado

• La versión sigue el formato: [major][minor][patch][hotfix]

Licencia

El código y los archivos de datos en esta distribución están licenciados bajo los términos de la GPLv3 publicada por la Free Software Foundation. Consulta https://www.gnu.org/licenses/ para obtener una copia de esta licencia.

Copyright (c) 2019 Proton AG