ProtonVPN Android 版

版权所有 (c) 2019 Proton AG

下载

构建说明

• 安装 sdk、ndk、cmake、swig
• 克隆此仓库
• ./gradlew assembleProductionVanillaOpenSourceDebug 或在 Android Studio 中打开并构建

构建发布版

要完成发布版构建，需要提供签名密钥：

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

代码风格

项目对 Java 使用约定的代码风格 ProtonStyle.xml。在 Android Studio 中通过 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 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 条款进行许可。请参阅 https://www.gnu.org/licenses/ 以获取该许可证的副本。

版权所有 (c) 2019 Proton AG