20、开源项目贡献指南：以YPImagePicker为例-优快云博客

本文链接：https://blog.youkuaiyun.com/ipfs8storage/article/details/155145621

开源项目贡献指南：以YPImagePicker为例

1. 开源项目贡献基础

在软件开发过程中，我们常常会使用到开源项目。当我们发现某些开源库不能完全满足我们的需求时，就可以考虑为其做出贡献。以GitHub上的项目为例，下面将详细介绍如何为开源项目做出贡献。

首先，我们需要在GitHub上拥有一个账户。虽然使用开源项目时不一定要有GitHub账户，但如果想要对GitHub上托管的项目进行贡献，就必须注册一个账户。可以通过 http://github.com/ 页面进行注册。注册完成后登录，并打开项目 https://github.com/Yummypets/YPImagePicker ，这个项目用于在我们的类Instagram应用中从图库选择图片。我们的目标是为其添加修改滤镜页面显示的滤镜的功能，目前该功能实现起来并不容易，直接修改Pods项目中的代码也不利于与其他开发者共享。

2. 分叉仓库

拥有GitHub账户后，就可以对仓库进行分叉操作。具体步骤如下：
1. 打开网页浏览器，访问 https://github.com 。
2. 打开想要分叉的项目（这里是YPImagePicker）。
3. 点击页面顶部的“Fork”按钮，这将启动分叉过程，会创建一个项目的特殊副本，你将有权限修改该副本中的代码。

分叉完成后，项目的地址变为 https://github.com/{user-name}/YPImagePicker/ ，其中 {user-name} 会被替换为你的GitHub用户名。在进行贡献之前，需要检查项目是否有相关的规则或政策。

接下来，可以将项目检出到本地进行修改。有两种方式可以获取分叉仓库的源代码：
- 使用终端执行命令： git clone https://github.com/{user-name}/YPImagePicker/
- 使用Xcode克隆项目：打开Xcode，选择“SourceControl”菜单，然后选择“Clone”选项，输入仓库地址 https://github.com/{user-name}/YPImagePicker/ 。

3. 扩展项目

下载项目源代码后，我们可以在Xcode中打开项目进行详细探索，以确定如何实现所需的新功能。我们知道YPImagePicker缺少方便修改所选图片可用滤镜列表的功能，因此我们将扩展传递给 YPImagePickerController 的配置，使其包含滤镜列表。

首先，创建一个简单的类来定义滤镜，以下是需要添加到库中的 YPFilterDescriptor.swift 类：

public class YPFilterDescriptor {
    let name:String
    let filterName:String

    public init(name: String, filterName: String ) {
        self.name = name
        self.filterName = filterName
    }
}

然后，在配置中添加一个属性来包含所有可用的滤镜：

public var filters:[YPFilterDescriptor] = [
    YPFilterDescriptor(name: "Normal", filterName: ""),
    YPFilterDescriptor(name: "Mono", filterName: "CIPhotoEffectMono"),
    YPFilterDescriptor(name: "Tonal", filterName: "CIPhotoEffectTonal"),
    YPFilterDescriptor(name: "Noir", filterName: "CIPhotoEffectNoir"),
    YPFilterDescriptor(name: "Fade", filterName: "CIPhotoEffectFade"),
    YPFilterDescriptor(name: "Chrome", filterName: "CIPhotoEffectChrome"),
    YPFilterDescriptor(name: "Process", filterName: "CIPhotoEffectProcess"),
    YPFilterDescriptor(name: "Transfer", filterName: "CIPhotoEffectTransfer"),
    YPFilterDescriptor(name: "Instant", filterName: "CIPhotoEffectInstant"),
    YPFilterDescriptor(name: "Sepia", filterName: "CISepiaTone")
]

配置对象包含了默认的滤镜列表。

还需要对 YPFiltersVC 类进行一些小的修改，以开始使用新的配置：

required init(image: UIImage, configuration: YPImagePickerConfiguration) {
    self.configuration = configuration
    super.init(nibName: nil, bundle: nil)
    title = configuration.wordings.filter
    self.originalImage = image
    filterPreviews = []
    //use the configuration to create all filters
    for filterDescriptor in configuration.filters {
        filterPreviews.append(YPFilterPreview(filterDescriptor.name))
        filters.append(YPFilter(filterDescriptor.filterName))
    }
}

这个新的 init 方法更新了滤镜列表，考虑了配置中的内容。如果配置没有变化，库将保持原来的行为。这种修改既扩展了控制能力，又保留了当前的行为，是一个设计良好的特性。

4. 创建拉取请求

分叉仓库后，我们可以使用GitHub的特殊功能将所有更改打包，并以特殊格式发送回原始仓库。GitHub用于将更改发送回原始项目仓库的格式称为拉取请求（Pull Request）。

拉取请求会显示你在自己的仓库（特定分支）中所做的所有更改与原始仓库的差异。一旦请求打开，它将跟踪两个仓库之间的所有更改，这意味着在请求打开期间，你可以进行额外的提交，这些提交也将成为拉取请求的一部分。

创建拉取请求的步骤如下：
1. 确认你已经提交了更改并将结果推送到自己的仓库。在项目根目录下，使用终端执行以下命令：
- git add .
- git commit -m "Extend the configuration to have a control over the list of filters"
- git push
2. 在浏览器中打开项目，地址为 https://github.com/{user-name}/YPImagePicker ，不要忘记替换 {user-name} 为你的GitHub用户名。
3. 点击“New pull request”按钮，这将准备拉取请求并显示其详细信息。
4. 你可以添加标题并详细解释拉取请求的内容，输入一些关于实现和可能改进的基本细节。
5. 点击底部的“Create pull request”按钮，这将创建拉取请求，并会开启一个特殊的线程，你可以与项目维护者进行讨论。

创建完成后，可以通过打开项目页面并点击“Pull requests”标签来验证拉取请求是否已打开。一旦拉取请求被接受，你的贡献将成为开源项目的一部分，GitHub会将其显示出来。

整个贡献过程可能需要一天到一个月不等，具体取决于项目的维护者，但最终使用该项目的人将受益。通过学习和实践，你可以将这些知识应用到其他项目中，与其他开发者共享你的更改，共同推动开源项目的发展。

以下是整个贡献过程的流程图：

graph LR
    A[注册GitHub账户] --> B[分叉仓库]
    B --> C[检出项目到本地]
    C --> D[扩展项目功能]
    D --> E[提交更改并推送]
    E --> F[创建拉取请求]
    F --> G{请求是否被接受}
    G -- 是 --> H[贡献成为项目一部分]
    G -- 否 --> I[根据反馈修改并重新提交]

在软件开发过程中，我们还会涉及到很多其他的概念和技术，例如：
| 概念 | 描述 |
| ---- | ---- |
| 类和结构体 | 是Swift中用于组织代码和数据的重要方式，具有属性、方法和类型属性等 |
| 继承 | 允许一个类继承另一个类的属性和方法，提高代码的复用性 |
| 协议 | 定义了一组方法和属性的规范，类、结构体或枚举可以遵循这些协议 |
| 数据结构 | 如数组、字典、集合等，用于存储和管理数据 |
| 网络请求 | 通过第三方库（如Alamofire）实现从网络获取数据 |
| 依赖管理 | 使用CocoaPods或Swift Package Manager来管理项目的依赖库 |

这些知识在开发iOS应用时都非常重要，希望大家不断学习和实践，提升自己的开发能力。

开源项目贡献指南：以YPImagePicker为例

5. 贡献总结与拓展

为开源项目做出贡献是一个有意义的过程，它不仅能让我们使用的库变得更好，还能与其他开发者共同成长。在为 YPImagePicker 项目贡献的过程中，我们经历了注册GitHub账户、分叉仓库、扩展项目功能和创建拉取请求等步骤。下面是这些步骤的总结表格：

步骤	操作内容
注册账户	通过 http://github.com/ 注册GitHub账户，登录后打开 https://github.com/Yummypets/YPImagePicker 项目
分叉仓库	打开网页浏览器访问 https://github.com ，找到项目点击“Fork”按钮，创建项目副本
检出项目	使用终端 `git clone https://github.com/{user-name}/YPImagePicker/` 或Xcode克隆项目
扩展功能	创建 `YPFilterDescriptor` 类，在配置中添加滤镜属性，修改 `YPFiltersVC` 类的 `init` 方法
创建请求	提交更改并推送，在浏览器打开项目点击“New pull request”，添加信息后点击“Create pull request”

除了为 YPImagePicker 项目贡献，我们还可以将这种贡献方式应用到其他开源项目中。以下是一些拓展建议：
- 选择合适的项目 ：根据自己的兴趣和技术栈，选择与自己开发方向相关的开源项目进行贡献。可以在GitHub上搜索热门项目，或者关注一些知名开发者的仓库。
- 阅读项目文档 ：在开始贡献之前，仔细阅读项目的文档，了解项目的架构、开发规范和贡献流程。这有助于我们更好地理解项目，避免犯一些低级错误。
- 参与社区讨论 ：加入项目的社区讨论，与其他开发者交流想法和经验。这不仅可以帮助我们解决遇到的问题，还能让我们更好地融入开源社区。

6. 相关技术知识回顾

在开发和贡献开源项目的过程中，我们会用到很多相关的技术知识。下面对一些重要的技术知识进行回顾：

6.1 Swift语言基础

变量和常量 ：变量用于存储可变的值，常量用于存储不可变的值。例如：

var variableName = "This is a variable"
let constantName = "This is a constant"

数据类型 ：Swift有多种数据类型，如整数、浮点数、字符串、布尔值等。还可以使用数组、字典和集合等集合类型来存储多个值。

let integerValue: Int = 10
let doubleValue: Double = 3.14
let stringValue: String = "Hello, Swift!"
let booleanValue: Bool = true

let array: [Int] = [1, 2, 3]
let dictionary: [String: Int] = ["one": 1, "two": 2]
let set: Set<Int> = [1, 2, 3]

控制流 ：Swift提供了 if 语句、 for 循环、 while 循环和 switch 语句等控制流语句，用于控制程序的执行流程。

if integerValue > 5 {
    print("The value is greater than 5")
}

for number in array {
    print(number)
}

var index = 0
while index < array.count {
    print(array[index])
    index += 1
}

switch integerValue {
case 1:
    print("The value is 1")
case 2:
    print("The value is 2")
default:
    print("The value is something else")
}

6.2 iOS开发相关

Model-View-Controller (MVC) ：是一种软件设计模式，将应用程序分为三个主要部分：模型（Model）、视图（View）和控制器（Controller）。模型负责存储数据，视图负责显示数据，控制器负责处理用户交互和协调模型与视图之间的通信。
网络请求 ：在iOS开发中，我们经常需要从网络获取数据。可以使用 URLSession 或第三方库（如Alamofire）来实现网络请求。以下是使用 URLSession 进行简单网络请求的示例：

let url = URL(string: "https://example.com/api/data")!
let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
    if let error = error {
        print("Error: \(error)")
    } else if let data = data {
        let json = try? JSONSerialization.jsonObject(with: data, options: [])
        print(json)
    }
}
task.resume()

依赖管理 ：使用CocoaPods或Swift Package Manager来管理项目的依赖库。例如，使用CocoaPods添加Alamofire库，需要在 Podfile 中添加以下内容：

platform :ios, '10.0'
target 'YourProjectName' do
    pod 'Alamofire', '~> 5.4'
end

然后在终端执行 pod install 命令来安装依赖库。

7. 持续学习与实践

软件开发是一个不断发展和变化的领域，我们需要持续学习和实践，才能跟上技术的步伐。以下是一些建议：
- 阅读优秀代码 ：阅读开源项目的代码，学习其他开发者的编程风格和设计模式。可以从一些知名的开源项目开始，如Alamofire、RxSwift等。
- 参与开源项目 ：除了为现有的开源项目贡献代码，还可以自己创建开源项目，与其他开发者分享自己的代码和经验。这不仅可以提高自己的技术水平，还能扩大自己的影响力。
- 参加技术社区和活动 ：加入技术社区，如Stack Overflow、GitHub等，与其他开发者交流和学习。参加技术活动，如技术讲座、研讨会等，了解最新的技术趋势和发展动态。

总之，通过为开源项目贡献代码、学习相关技术知识和持续实践，我们可以不断提升自己的开发能力，成为一名优秀的开发者。希望大家在软件开发的道路上不断探索和进步！

以下是学习和实践过程的流程图：

graph LR
    A[学习基础知识] --> B[阅读优秀代码]
    B --> C[参与开源项目]
    C --> D[参加技术活动]
    D --> E[持续实践与创新]
    E --> F{是否掌握新技术}
    F -- 是 --> G[应用到实际项目]
    F -- 否 --> A