android app

ПротонВПН для Android

Авторские права (c) 2019 Proton AG

Скачать

Инструкции по сборке

• Установите SDK, ndk, cmake, swig
• Клонировать этот репозиторий
• ./gradlew assembleProductionVanillaOpenSourceDebug или откройте и создайте в Android Studio

Выпуск сборки

Для завершения сборки выпуска необходимо предоставить ключи подписи:

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

Стиль кода

В проекте используется согласованный стиль кода ProtonStyle.xml для Java. Импортируйте его в студию Android через File>>Settings>>Editor>>Code style>>Import Scheme Для стиля кода Kotlin мы используем ktlint с правилами по умолчанию.

Содействие

Если вы хотите внести свой вклад, пожалуйста, помните о следующих правилах:

• Старайтесь придерживаться существующего стиля кода и соглашений об именах проекта.
• Кодовая база в основном написана на Java, но мы переходим на Kotlin, поэтому новый код по возможности следует писать на Kotlin.
• Наш предпочтительный технологический стек — Kotlin, MVVM, привязка данных и сопрограммы, поэтому любые новые функции или крупные рефакторинги должны соответствовать этому предпочтительному технологическому стеку.
• После добавления/обновления зависимостей с открытым исходным кодом запустите gradlew updateLicensesJson чтобы обновить атрибуции.

Внутренне наш CI автоматически проверяет все запросы на вытягивание на наличие проблем со стилем кода и запускает наши тесты. Однако вы также можете запустить их локально.

 gradlew checkstyle
gradlew detekt
gradlew test
gradlew androidTest

Внося свой вклад в этот проект, вы соглашаетесь со следующим:

1. Я передаю все авторские права, связанные с вкладом, компании Proton Technologies AG;
2. Я подтверждаю, что вклад был полностью создан мной;
3. Я понимаю и соглашаюсь с тем, что этот проект и вклад являются общедоступными и что запись о вкладе (включая всю личную информацию, которую я отправляю вместе с ним) хранится в течение неопределенного времени и может распространяться вместе с этим проектом или соответствующей лицензией открытого исходного кода.

Подпись

Все наши сборки (кроме F-droid) будут подписаны одним и тем же ключом. Отпечаток SHA256 для подписи сертификата

 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

Управление версиями

• Версия соответствует формату: [major][minor][patch][hotfix]

Лицензия

Код и файлы данных в этом дистрибутиве лицензируются на условиях GPLv3, опубликованных Free Software Foundation. См. https://www.gnu.org/licenses/ для получения копии этой лицензии.

Авторские права (c) 2019 Proton AG