mapbox / mapbox/MapboxGeocoder.swift
Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift
还没有人认领这个 Issue。
- 主要语言
- Swift
- 星标
- 133
- 派生
- 46
- PR 合并指标
- 30 天内没有已合并 PR
描述
This project was originally named MapboxGeocoder.swift because it started as a single file named MapboxGeocoder.swift in 2c2a827283d03fbd075719b7d158066084a3442a. (Lore has it that, even before this repository existed, it was a gist by the same name.) Over the years, the “dot swift” extension has been a bit of a mouthful and even occasionally a source of build issues: https://github.com/mapbox/MapboxGeocoder.swift/issues/59#issuecomment-327346187. Having “.swift” in the name also causes confusion because the library also supports Objective-C. Emphasizing Swift in contrast to Objective-C matters less and less these days in Apple-centric environments like CocoaPods.
As we’re doing with MapboxDirections.swift in mapbox/mapbox-directions-swift#399, I think we should consider renaming the project to “Mapbox Geocoder for Swift”, the repository to mapbox/mapbox-geocoder-swift, and the pod to simply “MapboxGeocoder”. Any developer installing the library using CocoaPods would need to replace `MapboxGeocoder.swift` with `MapboxGeocoder` in their Podfile. Otherwise, there’s no immediate impact to developers, since GitHub automatically redirects renamed repositories.
Ideally, this change would take place as part of a v1.0 release that also drops Objective-C compatibility. However, there aren’t active plans for either at the moment, so this issue is just a placeholder for now.
The steps to rename look roughly like this:
* [ ] Replace occurrences of “MapboxGeocoder.swift” in the repository
* [ ] Rename the repository to mapbox/mapbox-geocoder-swift
* [ ] Update Bitrise configuration
* [ ] Update CircleCI configuration
* [ ] Update Codecov configuration
* [ ] Publish v1.0 (and any prereleases) to a new “MapboxGeocoder” pod
* [ ] Deprecate the MapboxGeocoder.swift pod in favor of the MapboxGeocoder pod
* [ ] Update documentation across docs.mapbox.com
/cc @mapbox/ios
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先在仓库中搜索“MapboxGeocoder.swift”,并检查 Bitrise、CircleCI 和 Codecov 配置、Podfile 引用以及文档链接。在协调 v1.0 发布和弃用计划之前,确认仓库、pod 和项目的命名变更。完成的标准是清单已全部完成,其中包括对 docs.mapbox.com 的更新以及面向 CocoaPods 用户的迁移指南。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- swift
- 领域
- build-system, ci-cd, documentation, release
- Issue 类型
- 重构
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100