¿Cómo colaborar con el Xamarin Community Toolkit?

Contribuir en el Xamarin Community Toolkit

Una de los puntos a favor de Xamarin es su increíble comunidad. Una comunidad activa haciendo constantemente actividades (eventos online, eventos presenciales, etc.) y creando nuevo contenido (artículos, ejemplos, plugins, etc.). Con el paso del tiempo es fantástico ver más y más plugins además de diferentes retos de UI y otro tipo de contenidos que son de ayuda para todos.

El Xamarin Community Toolkit es un proyecto Open Source apoyado por Microsoft, pero donde el motor es la comunidad. Es por y para la comunidad, así que es, un proyecto ideal donde colaborar.

Recibo en ocasiones correos o mensajes en varios medios (Slack, Skype, etc.) preguntando como formar parte del Toolkit. En este artículo, voy a hacer un repaso en las diferentes formas en las que se puede contribuir en el Xamarin Community Toolkit, así como compilar el proyecto, poder tomar issues o mejoras, etc.

¿Te interesa?. Vamos a por ello!.

Consejos antes de comenzar

Antes de empezar, colaborar en proyectos Open Source tiene partes positivas como:

  • Vas a ayudar a otros!.
  • Es una forma divertida de aprender.
  • Etc.

Sin embargo, si nunca has colaborado antes probablemente tengas algunas dudas. La primera de ellas será como hacerlo. Para eso espero que este artículo sea de ayuda. El segundo de los posibles problemas esta en el conocido “síndrome del impostor”. Dudas si lo que haces es correcto,  etc. En este punto, no te preocupes!. Si hay algo que se pueda mejorar, lo verás en el feedback. Es parte de la “gracia” de colaborar así, aprenderás posiblemente cosas nuevas.

Tan solo recuerda:

  • No tengas dudas. Aprenderás cosas nuevas como yo y todos lo hacemos a diario.
  • Puedes preguntar al crear la PR lo que necesites!.

Formas de contribuir

Lo primero de todo, contribuir tiene varias definiciones aunque en este caso:

“se trata de ayudar y concurrir con otros al logro de un cierto fin”

Se puede ayudar de muchas formas!. No tienes porque implementar la espectacular funcionalidad X para poder contribuir.

Vamos a repasar las diferentes opciones disponibles:

  • Reportar una issue.
  • Aportar ideas para nueva funcionalidad.
  • Correcciones en la documentación.
  • Corregir una issue.
  • Nueva funcionalidad.

Reportar una issue

Es una de las formas más sencillas de contribuir. Tienes un problema usando el Xamarin Community Toolkit, algo que no se comporta cómo debería. Abre una issue. De esta forma, avisarás que algo no funciona como debe; se corregirá y en el futuro otros devs tendrán la corrección gracias a que avisaste el problema.

Nueva issue

Los pasos a seguir son sencillos:

  1. Logra reproducir un problema de forma constante.
  2. Escribe una Issue explicando el problema. Lo fundamental es detallar en pasos como reproducir el problema.
  3. Detallada cual es el comportamiento que estas obteniendo y cual es el esperado (ayuda a determinar si es una Issue o no).
  4. Añade la versión del Xamarin Community Toolkit utilizada así como la plataforma o plataformas afectadas.
  5. Si es posible, añade algunas capturas.
  6. Si es posible (ayuda muchísimo), añade un pequeño ejemplo adjunto donde reproducir el problema.

Voila!. Sencillo, ¿verdad?.

Aportar ideas, añadir nueva funcionalidad

“Estaría genial tener esta propiedad en este control”. Haz una propuesta. Es sencillo, al final es como escribir una issue pero con ligeros cambios.

Los pasos a seguir serían:

  1. Piensa, analiza y piensa de nuevo tu idea.
  2. Abre una issue con el título “[Enhancement] …” y añade una descripción detallada de lo que buscas con esta mejora.
  3. Si has pensado una posible definición para la API añadela.
  4. Si puedes, añade un pequeño ejemplo (Scenario) donde enseñar como se usaría la nueva funcionalidad.
  5. ¿Afecta a alguna API existente?. Indícalo.
  6. Si puedes, añade el nivel de dificultad necesario para implementar la nueva funcionalidad (bajo, medio, alto).
  7. Añade el tag enhancement.

Actualizar documentación

¿Encontraste algún error en la documentación?, ¿falta documentación de alguna funcionalidad?. Puedes enviar actualizaciones en la documentación.

Documentación!

Corregir una issue

En este nivel de contribución se ha seleccionado una issue específica a corregir, cuentas con el código fuente sincronizado y ya te dispones a modificar código. Vamos a ver con más detalles este proceso un poco más adelante.

Añadir una nueva funcionalidad

Similar al caso anterior. La diferencia radica que en este caso creas una funcionalidad nueva en lugar de corregir una issue.

Compilar el proyecto

Para compilar el proyecto debemos comenzar por tener el mismo. Es sencillo:

git clone https://github.com/xamarin/XamarinCommunityToolkit.git C:\XamarinCommunityToolkit

Usando Visual Studio (Windows o macOS), tras obtener el proyecto no deberás hacer nada especial para compilarlo. Abre la solución Xamarin.CommunityToolkit.Sample.sln y pulsa F5.

Conociendo el proyecto

La solución del Xamarin Community Toolkit no es relativamente grande pero, veamos las calves del proyecto:

  • Xamarin.CommunityToolkit: Aquí puedes encontrar la librería del Toolkit. Dentro de la librería se encuentra todo organizado en carpetas (Converters, Effects, Views, etc).
  • Xamarin.CommunityToolkit.Sample: Es un ejemplo donde probar todo lo implementado en el Toolkit. Es muy recomendable usar este ejemplo si añades algo nuevo o haces una corrección para validar los cambios.
  • Xamarin.CommunityToolkit.UnitTests: Un proyecto con tests unitarios de elementos clave.
Estructura del proyecto

Trabajar en una corrección

Ya tienes el proyecto sincronizado y tienes una Issue seleccionada. Ahora si, manos a la obra. Pero antes de comenzar, crea una nueva rama partiendo de lo último disponible en main.

No se requiere cumplir un patrón específico a la hora de crear la rama. Mis recomendaciones serían:

  • Si es un fix, puedes crear una rama “fix{id}” donde el id es el identificador de la Issue.
  • Puedes usar un nombre descriptivo. Por ejemplo, si estas corrigiendo un error al seleccionar un elemento en el TabView podría ser algo como “fix_tabview_selectindex”.
  • También puedes usar una combinación de las ideas anteriores. Por ejemplo: “fix_1234_tabview_selectindex”.

A la hora de trabajar con el código recuerda cumplir las guías de estilo de código usadas en la .NET Foundation.

Una vez aplicados los cambios necesarios, considera lo siguiente:

  • Si es una corrección, es posible que un test unitario o UITest encaje y ayude a evitar regresiones en el futuro.
  • Si has añadido algo nuevo, modifica el Sample para reflejar la nueva opción.

El momento de enviar la PR

Añade un título descriptivo junto con una buena descripción (si hay cambios visuales o añadiste algun ejemplo o UITest, añade capturas de pantalla). Si has corregido una issue (o issues) añade el enlace a las mismas.

A continuación, si hay cambios en API añade los detalles. Por último, rellena el checklist indicando si hay UITests, etc.

Todo listo para enviar!. Una vez enviado, miembros del equipo así como de la comunidad comenzarán a revisar todo. Una vez pasadas revisiones, builds y otras validaciones. Enhorabuena, tus cambios estarán incluidos en el Xamarin Community Toolkit!.

Hasta aquí. Creo que hemos realizado un buen resumen de como contribuir en el Xamarin Community Toolkit. Además de todo lo expuesto, si puedo ayudar en algo tan solo avísame. Por otro lado, estoy pensando en la idea de hacer algun streaming en Twitch abordando este tema, ¿te resultaría interesante?. Cualquier feedback es bienvenido en los comentarios de la entrada!.

Más información

Un pensamiento en “¿Cómo colaborar con el Xamarin Community Toolkit?

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión /  Cambiar )

Google photo

Estás comentando usando tu cuenta de Google. Cerrar sesión /  Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión /  Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión /  Cambiar )

Conectando a %s