NIP 12 – Rebranding
Introducción
El Comité Directivo de Migración ha llevado a cabo el proceso de creación de una nueva marca para Catapult. La nueva marca “Symbol from NEM” ha sido apoyada por la comunidad junto con el ticker XYM.
El objetivo de este NIP es coordinar los esfuerzos para cambiar el nombre de todos los repositorios bajo la organización nemtech en GitHub.
Especificaciones
Paquetes
Los nombres de los repositorios, URL y nombres de paquetes instalables se editarán de la siguiente manera:
Anterior | Nuevo |
---|---|
nem2-* | symbol-* |
catapult-* | symbol-* |
Catapult | Symbol |
En este momento, no hay planes para eliminar las referencias internas de catapult de catapult-server ni el código de catapult-rest.
Todos los paquetes relacionados con nem2- * se eliminarán de npmjs y maven para evitar que los usuarios instalen y la versión anterior del paquete por error.
Organización
Todos los repositorios dentro de la organización nemtech serán transferidos a la nueva organización de plataforma de símbolos.
La organización nemtech GitHub mantendrá un enlace en la descripción de la nueva entidad.
Páginas Github
La organización nemtech conservará el repositorio nemtech.github.io para redirigir los enlaces relacionados con las páginas de GitHub (por ejemplo, nem2-docs, referencias SDK, nem2-openapi) a la nueva URL de la organización https: // desarrollador. . .
Ticker
Las referencias codificadas a nem.xem deben reemplazarse por symbol.xym. Para la moneda de red predeterminada de las redes privadas, se seguirá utilizando cat.currency.
Cl
Es posible que algunos servicios externos deban ser reconfigurados manualmente por repositorio, incluidos:
- TravisCI
- Overoles
Cada organizador de firmas debe dar prioridad a agregar nuevamente los servicios requeridos para fusionar nuevos RP en el maestro (por ejemplo, probar tuberías) antes de agregar nuevas características a cada proyecto.
Re Diseño
Si es necesario, adapte los colores, las fuentes y el logotipo de acuerdo con la última actualización de la marca.
Se recomienda que cada repositorio cree una rama separada para comenzar a aplicar el rediseño sin interferir con otras características entrantes.
Decisiones de Diseño
La especificación propuesta intenta minimizar los errores 404 al acceder a enlaces antiguos.
Los enlaces de los repositorios movidos a la nueva organización se redirigen automáticamente a la nueva ubicación (excepto las páginas de GitHub). El tiempo en que las redirecciones están activas puede cambiar, ya que es administrado por GitHub.
Para resolver la redirección de páginas de GitHub, mantendremos el nemtech.github.io dentro de la organización nemtech y desarrollaremos un script .js personalizado para redirigir a cada nueva URL en consecuencia.
Implementación
Para cada proyecto, se creará un nuevo problema llamado “Rebranding” con la siguiente lista de tareas:
- [] Se creó una rama de cambio de marca
- [] Nuevo diseño aplicado (fuente, logotipos, colores)
- [] Redenominados referencias de nombre clave
- [] Referencias de ticker renombradas
- [] Enlaces revisados
- [] README revisado
- [] PR creado
- [] Paquete renombrado
- [] Paquete desplegado / etiqueta creada
Hito 1
Repositorios de destino:
- nem2-sdk-typescript-javascript
- nem2-openapi
- nemstudios/nem2-open-api-generator (migrated GitHub & npm nemtech org)
- nemstudios/catbuffer-generator (migrated to npm nemtech org)
- nem2-sdk-java
Hito 2
Repositorios de destino:
- nem2-docs
- nem2-cli
- nemfoundation/symbol-desktop-wallet-beta
- nemfoundation/nem2-explorer
Hito 3
Repositorios de Destino:
- catapult-service-bootstrap
- catapult-whitepaper
- nem2-e2e-tests
- nem2-scenarios
- nemfoundation/nem2-uri-scheme
- nemfoundation/nem2-hd-wallets
- nemfoundation/nem2-qrlibrary
Hito 4
Repositorios de Destino:
- catapult-server
- catapult-rest
- catbuffer
Hito 5 (en discusión)
- symbolplatform GitHub org creado
- desarrolladores principales asignados como propietarios de la organización
- dominio redirigido a la organización
- script para redirigir enlaces nemtech.github.io
- repositorios migrados
- Servicios de CI migrados
Compatibilidad al revés
- No será posible migrar todos los enlaces.
- Podría penalizar el SEO del proyecto.
Sin embargo, es preferible a largo plazo tener una marca consistente, y aplicar esos cambios más temprano que tarde causará menos redirecciones en el futuro.
Alternativas
Se están considerando otras alternativas:
- Mantenga todos los repositorios en nemtech (sin renombrar la organización) para evitar redirecciones.
La razón de tener una organización GitHub para NIS1 (NEMProject) y otra para Catapult (nemtech) era tener una forma clara de separar los repositorios por tecnología para evitar confusiones. Si no, cada repositorio de Catapult estaría bajo el Proyecto NEM. Sin embargo, los nombres elegidos no son lo suficientemente descriptivos como para diferenciar el contenido de ambas organizaciones.
- Cambie el nombre de la organización nemtech a la plataforma de símbolos y cree una nueva organización llamada nemtech para manejar las redirecciones
Existe el riesgo de perder el nombre nemtech para siempre, ya que estará disponible para que todos puedan registrarse.
- No renombrar catapult-server y catapult-rest a symbol-server y symbol-rest.
Fuente: Github NEM