如何为Simplenote iOS贡献代码：完整的开发者指南

如何为Simplenote iOS贡献代码：完整的开发者指南

【免费下载链接】simplenote-iosSimplenote for iOS项目地址: https://gitcode.com/gh_mirrors/si/simplenote-ios

Simplenote for iOS是一款简洁高效的笔记应用，本文将为你提供完整的开发者指南，帮助你轻松参与到这个开源项目的贡献中来，无论是修复bug还是添加新功能，都能让你快速上手。

准备开发环境：快速搭建步骤

安装必要工具

首先，你需要下载并安装Xcode 10.2或更高版本，因为Simplenote for iOS使用Swift 5，需要相应版本的开发工具。Xcode可以从Apple开发者网站获取。

然后，安装项目所需的第三方工具。在命令行中运行以下命令来安装或更新依赖：

rake dependencies

其中，SwiftLint会在你构建应用时自动安装，它用于强制执行Swift代码的通用风格，确保代码质量。

打开项目

通过命令行启动项目是个不错的选择，运行以下命令：

rake xcode

这会确保所有依赖都准备就绪后再启动Xcode。你也可以双击Simplenote.xcodeproj文件，或者在Xcode中选择File>Open并浏览到该文件来打开项目。

解决常见Xcode问题：顺畅开发的关键

在初次设置Simplenote iOS时，可能会遇到一些常见错误。如果你看到The server SSH fingerprint failed to verify警告，点击警告并选择“信任”即可。

若构建失败并显示Authentication failed because the credentials were missing错误，很可能是需要更新Swift Packages。我们使用Swift Package Manager来管理一些内部依赖，这些依赖可在Github上找到。你需要将Xcode连接到Github，具体操作是进入Xcode > Preferences > Accounts，输入你的Github账户详情。为了能够获取这些依赖，Xcode需要通过SSH连接到Github账户。

完成信任应用和下载SPM包后，尝试再次按下Command + B，确保应用能够正确构建。

设置凭据：连接Simperium服务

Simplenote由Simperium Sync'ing protocol提供支持。要将开发构建的Simplenote iOS连接到Simperium同步服务，你需要先设置应用凭据。我们会分发测试凭据，帮助验证API调用的有效性。

请按以下步骤复制测试Simperium凭据：

mkdir -p ~/.configure/simplenote-ios/secrets && cp Simplenote/SPCredentials-demo.swift ~/.configure/simplenote-ios/secrets/SPCredentials.swift

这会将演示的SPCredentials文件复制到正确的目录，并包含OSS贡献者的基本详细信息。然后编辑新的Simplenote/Credentials/SPCredentials.swift文件，将simperiumAppID和simperiumApiKey字段更改为Simperium应用中显示的正确值。如果看不到该文件，尝试按下Command + B进行构建，然后重启Xcode，通常就能看到了。

这样你就可以在设备或模拟器上编译和运行应用了。在模拟器中运行应用时，你可以连接到Simplenote。注意，对于测试构建，你只能使用Simperium.com账户的电子邮件地址和密码连接到Simplenote账户，无法在开发构建中连接到常规的Simplenote账户。并且，Simplenote API功能如共享和发布在开发构建中无法使用。

如果你想在本地尝试生成截图，还需要为该目标创建自己的测试凭据：

mkdir -p ~/.configure/simplenote-ios/secrets && cp Simplenote/ScreenshotsCredentials-demo.swift ~/.configure/simplenote-ios/secrets/ScreenshotsCredentials.swift

遵循代码风格：保持项目一致性

我们遵循WordPress iOS风格指南，并且不断改进和采用最新技术。具体的风格标准如下：

• Swift代码遵循Swift Standard
• Objective-C代码遵循ObjC Standard

提交代码更改：成为贡献者的步骤

我们欢迎针对任何未解决问题的bug修复的拉取请求！所有代码贡献都通过拉取请求进行。如果你之前没有创建过拉取请求，推荐观看免费视频系列How to Contribute to an Open Source Project on GitHub。

PR合并政策

• PR需要一名审核者批准后才能合并到基础分支
• 合并时我们会保留PR的git历史（通过“合并提交”方式合并）
• 一旦PR获得批准且状态为绿色，谁来合并呢？
  • 对于组织外部且没有推送权限的人提交的PR，批准该PR的审核者将进行合并。
  • 对于有推送权限的贡献者提交的PR，PR的作者将自己合并。

开始贡献：从克隆仓库开始

要开始为Simplenote iOS贡献代码，首先需要克隆仓库，仓库地址是 https://gitcode.com/gh_mirrors/si/simplenote-ios 。克隆完成后，按照前面的步骤设置开发环境、解决可能遇到的问题、设置凭据，然后就可以根据自己的兴趣和能力选择合适的任务进行贡献啦！

希望这份指南能帮助你顺利成为Simplenote iOS项目的贡献者，让我们一起让这款优秀的笔记应用变得更好！ 🚀

【免费下载链接】simplenote-iosSimplenote for iOS项目地址: https://gitcode.com/gh_mirrors/si/simplenote-ios