mapbox / mapbox/MapboxGeocoder.swift

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift

オープン
#205 コメント 0 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

backwards-incompatible build
主要言語
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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. 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
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。