mapbox / mapbox/MapboxGeocoder.swift

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift

Đang mở
#205 0 bình luận 3 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

backwards-incompatible build
Ngôn ngữ chính
Swift
Star
133
Fork
46
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách tìm kiếm “MapboxGeocoder.swift” trong repository và xem lại các cấu hình Bitrise, CircleCI và Codecov, các tham chiếu đến Podfile cũng như các liên kết tài liệu. Xác nhận các thay đổi về tên của repository, pod và project trước khi phối hợp phát hành v1.0 và kế hoạch ngừng hỗ trợ. Được xem là hoàn tất khi checklist đã đầy đủ, bao gồm cả các cập nhật trên docs.mapbox.com và hướng dẫn migration cho người dùng CocoaPods.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
swift
Lĩnh vực
build-system, ci-cd, documentation, release
Loại issue
Tái cấu trúc
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.