mapbox / mapbox/MapboxGeocoder.swift

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift

Ouverte
#205 0 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

backwards-incompatible build
Langage dominant
Swift
Étoiles
133
Forks
46
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par rechercher « MapboxGeocoder.swift » dans le dépôt et par examiner les configurations de Bitrise, CircleCI et Codecov, les références à Podfile ainsi que les liens vers la documentation. Confirmez les changements de nom du dépôt, du pod et du projet avant de coordonner la release v1.0 et le plan de dépréciation. C’est terminé lorsque la checklist est complète, y compris les mises à jour de docs.mapbox.com et les instructions de migration pour les utilisateurs de CocoaPods.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
swift
Domaine
build-system, ci-cd, documentation, release
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.