mapbox / mapbox/MapboxGeocoder.swift

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift

Abierto
#205 0 comentarios 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

backwards-incompatible build
Lenguaje dominante
Swift
Estrellas
133
Forks
46
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza buscando en el repositorio “MapboxGeocoder.swift” y revisando las configuraciones de Bitrise, CircleCI y Codecov, las referencias de Podfile y los enlaces de documentación. Confirma los cambios de nombre del repositorio, el pod y el proyecto antes de coordinar el lanzamiento de v1.0 y el plan de deprecación. Se considera terminado cuando la checklist esté completa, incluidas las actualizaciones de docs.mapbox.com y la guía de migración para usuarios de CocoaPods.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
swift
Área
build-system, ci-cd, documentation, release
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.