mapbox / mapbox/MapboxGeocoder.swift
Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Swift
- Sterne
- 133
- Forks
- 46
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Suche im Repository nach „MapboxGeocoder.swift“ und überprüfe die Bitrise-, CircleCI- und Codecov-Konfigurationen, die Podfile-Referenzen sowie die Dokumentationslinks. Bestätige die Änderungen an den Namen des Repositorys, des Pods und des Projekts, bevor du die Veröffentlichung von v1.0 und den Deprecation-Plan koordinierst. Als erledigt gilt die Aufgabe, wenn die Checkliste vollständig ist, einschließlich der Aktualisierungen auf docs.mapbox.com und der Migrationsanleitung für CocoaPods-Nutzer.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- swift
- Bereich
- build-system, ci-cd, documentation, release
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100