mapbox / mapbox/MapboxGeocoder.swift
Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift
Nessuno ha ancora preso questa issue.
- Lingua principale
- Swift
- Stelle
- 133
- Fork
- 46
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia cercando “MapboxGeocoder.swift” nel repository e esaminando le configurazioni di Bitrise, CircleCI e Codecov, i riferimenti a Podfile e i link alla documentazione. Conferma le modifiche ai nomi del repository, del pod e del progetto prima di coordinare il rilascio della v1.0 e il piano di deprecazione. Il lavoro è completo quando la checklist è completa, inclusi gli aggiornamenti a docs.mapbox.com e le indicazioni per la migrazione degli utenti di CocoaPods.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- swift
- Ambito
- build-system, ci-cd, documentation, release
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100