Cómo Construir Tu Propio Proyecto de Código Abierto

Rate this content
Bookmark

Todos usamos proyectos de código abierto todos los días, como paquetes de npm, editores, aplicaciones web e incluso sistemas operativos... ¿Alguna vez has pensado en construir uno propio? En esta charla, compartiré mi experiencia construyendo jest-preview, desde cuando era solo una idea vaga, hasta convertirse en una biblioteca ampliamente adoptada para ayudar a los ingenieros frontend a escribir pruebas más rápido. Compartiré contigo cómo encontrar una idea para un proyecto en el que trabajar, cuáles son los desafíos que debes superar como autor de un proyecto de código abierto, cómo administrar el tiempo de manera eficiente y cómo llamar la atención de los ingenieros de todo el mundo.

16 min
24 Oct, 2022

Video Summary and Transcription

Hola amigo, en esta charla quiero compartir contigo cómo construir tu propio proyecto de código abierto. Construir un proyecto de software de código abierto puede ser desafiante. Recibo muchas cosas al azar en un día, como mensajes de agradecimiento por hacer mi vida más fácil, lo cual me motiva. Para elegir un proyecto de código abierto en el que trabajar, elige uno que uses todos los días. Tu software está siendo utilizado cuando las personas informan problemas y envían solicitudes de extracción.

Available in English

1. Introduction to JestPreview

Short description:

Hola amigo, en esta charla quiero compartir contigo cómo construir tu propio proyecto de código abierto. ¿Has contribuido a algún proyecto de código abierto? Si no lo has hecho, espero que lo hagas después de mi charla. Soy Hung, creador de JestPreview, una biblioteca que te brinda una experiencia de depuración visual al probar una aplicación de front-end. JestPreview te permite renderizar HTML en un navegador real, lo que facilita la depuración y corrección de errores. Tiene muchos beneficios, como escribir pruebas más rápidamente y poder ver la interfaz de usuario mientras escribes pruebas unitarias o de integración. Te mostraré una demostración.

A mí me encanta, y en esta charla quiero compartir contigo cómo construir tu propio proyecto de código abierto. Pero primero, déjame hacerte una pregunta. ¿Has contribuido a algún proyecto de código abierto? Si es así, ¡genial! Pero si no, espero que lo hagas después de mi charla.

Hola, mi nombre es Hung, soy el creador de JestPreview, una biblioteca que te brinda una experiencia de depuración visual al testing una aplicación de front-end. También soy miembro de BestOfJay.org, un sitio web que te ayuda a seguir el crecimiento del ecosistema de JavaScript. También estoy en Twitter, ¡conéctate conmigo!

En esta charla, quiero compartir contigo qué es JestPreview y por qué construirlo, las dificultades que tuve que superar al construir un proyecto de software de código abierto, lo que recibí de la comunidad, y algunos consejos si quieres construir el tuyo propio. Primero, ¿qué es JestPreview y por qué construirlo? El problema es que si eres un ingeniero, y si eres un ingeniero de front-end y escribes pruebas, tienes que trabajar mucho con la terminal de Node. Si encuentras un error, tienes que mirar el largo HTML en la terminal y es muy difícil depurar y corregirlo. Ni siquiera sabes cómo se ve tu aplicación cuando se ejecutan tus pruebas. ¿Alguna vez has intentado hacer clic en un botón pero no hay botón, solo un spinner que se carga en tu prueba? Entonces me hice esa pregunta, si Jest puede imprimir el HTML, ¿podemos renderizarlo en un navegador real? Y hasta ahora, la respuesta es sí, podemos. Como puedes ver, este es un caso de prueba escrito en la biblioteca de pruebas de React, la interacción del usuario está controlada por user-event. Y en lugar de usar screen.debug, usamos preview.debug para ver la interfaz de usuario real en nuestra aplicación en el navegador. Y cada vez que guardas, el navegador actualiza la interfaz de usuario casi de inmediato. Tiene muchos beneficios. El primero es que puedes depurar una prueba fallida mucho más fácilmente. Puedes saber cómo se ve tu aplicación. Por lo tanto, puedes escribir fácilmente tu próximo paso de testing. Por lo tanto, puedes ejecutar tus pruebas más rápido. E incluso si estás escribiendo pruebas unitarias o de integración, aún puedes ver la interfaz de usuario. Intenta cerrar la brecha entre las pruebas unitarias y las pruebas de integración con pruebas de extremo a extremo. En mi experiencia personal, escribo de 2 a 3 veces más rápido gracias a JustPreview. Quiero mostrarte una demostración. Como puedes ver, esta es una aplicación normal escrita en la biblioteca de pruebas de testing. En el lado derecho, puedes ver la interfaz de usuario que JustPreview te muestra. Permíteme ejecutar solo 1 paso y la prueba se ejecutará nuevamente. Y puedes ver que el número de conteo disminuye de 6 a 5. Permíteme disminuirlo nuevamente. Puedes ver que de 5, pasará a 4. Y eso es JustPreview.

2. Struggles and Rewards of Open Source

Short description:

Construir un proyecto de software de código abierto puede ser desafiante. Comprender el marco en detalle, encontrar respuestas a preguntas específicas y administrar el tiempo de manera efectiva son algunas de las dificultades. Es importante recordar por qué comenzaste el proyecto y considerar opciones de apoyo financiero. El código abierto brinda conocimiento, oportunidades y conexiones con excelentes ingenieros y autores de bibliotecas de código abierto.

Y ahora quiero compartir algunas dificultades que tuve que superar al construir un proyecto de software de código abierto. En primer lugar, es difícil porque cuando usas un marco y no necesitas entenderlo en profundidad, pero cuando construyes un proyecto de software de código abierto, es probable que necesites entenderlo en mucho, mucho detalle. A veces quieres hacer una pregunta, pero es probable que no encuentres una respuesta en Google o Stackoverflow.

Por ejemplo, así es como funciona el módulo CDF, pero cuando construí JustPreview para admitir el módulo CDF, tuve que profundizar en el código fuente del módulo CDF, y este es el código con el que tengo que trabajar para que JustPreview funcione con el módulo CDF. Pero es una buena oportunidad para aprender, porque cada vez que superamos un problema difícil, aprendemos mucho.

Lo siguiente es el tiempo. El software de código abierto requiere mucho tiempo, especialmente si tienes un trabajo a tiempo completo, por lo que debes administrar bien tu tiempo, y mi consejo es siempre tener un plan, y mi cita favorita es que un buen plan hoy es mejor que un plan perfecto mañana. Además, también creo que, dado que es un proyecto de código abierto, muchas personas vendrán a ayudarte, pero en realidad no es cierto para un proyecto de código abierto pequeño. Es posible que seas el único mantenedor. A veces solo quieres rendirte o archivar el proyecto. Pero en ese momento, recuerda por qué lo comenzaste en primer lugar. El éxito es financiero. Si solo lo haces por diversión, está bien. Pero si te tomas en serio trabajar en código abierto, puedes considerar patrocinadores de GitHub, Open Collective o incluso algún modelo freemium.

Quiero compartir lo que recibo al hacer código abierto. Primero es el conocimiento. Mucho conocimiento. Sé cómo funciona el Bundler en el fondo. Sé cómo procesar CSS en aplicaciones web modernas. Tengo que leer mucho código abierto, por lo que mejoro mis habilidades de lectura y desarrollo de código. Entiendo cómo funciona la herramienta en el fondo. Me convierte en un mejor programador. Luego viene la oportunidad. Recibo muchas oportunidades al hacer código abierto. Mi proyecto, Jazz Preview, fue nominado para el premio Most Exciting Use of Technology en los Open Source Awards en React Summit. Es simplemente emocionante y nunca lo había pensado antes. En cuanto a los trabajos, recibo muchas invitaciones para aplicar y es simplemente increíble porque no necesitas buscar trabajo, sino que el trabajo te encontrará. Y luego están las conferencias y eventos tecnológicos, tengo la oportunidad de participar en ellos. Además, tengo la oportunidad de conversar con muchos ingenieros excelentes, autores de bibliotecas de software de código abierto que uso a diario. Antes de hacer código abierto, nunca pensé que podría discutir temas técnicos con ellos.

3. Tips for Building an Open Source Project

Short description:

Recibo muchas cosas al azar en un día, como mensajes de agradecimiento por hacer mi vida más fácil, lo cual me motiva. Para elegir un proyecto de código abierto en el que trabajar, elige uno que uses todos los días. Comienza con algo simple, como un MVP o una prueba de concepto, y mejora con el tiempo. Encuentra un mantenedor de archivos para obtener apoyo y motivación. No comiences en la versión 1, ya que es una fase experimental. Cuando uses tu proyecto como usuario, ajusta y agrega funciones para mejorar la usabilidad. Busca comentarios de amigos y colegas. Presta atención a los problemas y las discusiones a medida que tu proyecto gana atención.

Pero es genial haber conocido a algunos de ellos en persona. Es posible que reconozcas a algunos de ellos aquí. Y luego está el hecho de que recibo muchas cosas al azar en un día, que recibo algo como un agradecimiento por hacer esto, que hace mi vida mucho más fácil. Y eso realmente me motiva a seguir haciéndolo. Nunca había experimentado eso antes cuando solo tenía un trabajo de 9 a 5.

Entonces, ¿cómo hacerlo? Ahora quiero compartir algunos tips para construir tu propio proyecto de código abierto. Primero, ¿cómo elegir un proyecto de código abierto en el que trabajar? La respuesta es muy fácil, debe ser un proyecto que uses todos los días. Si quieres construir tu propio proyecto de código abierto, tu proyecto futuro debe resolver tus propios problemas. Es muy difícil contribuir a un proyecto del que no tienes contexto, simplemente elige uno proyecto que uses todos los días y contribuye a él. Y sabes que, en un trabajo diario, pasamos mucho tiempo en un problema en particular, y hay muchas posibilidades de que otras personas tengan el mismo problema. Así que simplemente hazlo de código abierto, y no necesita ser algo muy grande.

A continuación, comienza de forma sencilla. Ningún proyecto es complicado cuando se trata de trabajo. Simplemente comienza de forma sencilla, haz primero un MVP o una prueba de concepto, y mejóralo con el tiempo, y está bien si el código no está limpio en la fase inicial. Y si alguna vez te pierdes, está bien, eso es una señal de que vas a aprender mucho. A continuación está el mantenedor de archivos. Sabes, construir un proyecto de código abierto es difícil y estresante. Sería mucho más fácil para ti tener a alguien con quien discutir aspectos técnicos y motivarte a continuar con el proyecto. Y no comiences en la versión 1, porque un nuevo proyecto está lleno de pruebas de concepto y experimentos. v1, eso significa que tu software debe ser compatible con versiones anteriores cuando lanzas una nueva versión. Y en las versiones semánticas, el término en la relación de la versión principal es cero. Es para el desarrollo inicial. Y cualquier cosa puede cambiar, y la API pública no debe considerarse estable. Ahí puedes avanzar rápido. A continuación, cuando comienzas un proyecto para resolver un problema en particular, pero cuando lo usas como un usuario normal, sabes si es lo suficientemente bueno, o si necesitas ajustarlo o agregar más funciones para hacerlo más usable. Por ejemplo, cuando construí JustPreview, todo lo que quería era previsualizar la interfaz de usuario en Jest a Chrome, punto. Pero cuanto más lo uso, más funciones agrego para hacerlo más fácil de usar, como la recarga automática al guardar, procesar CSS, imágenes y agregar un nuevo modo automático, etc. A continuación, tienes un proyecto, pero puede ser subjetivo. Pregunta a tus amigos, colegas y tu red qué proyecto debería cambiar para ser más usable. Después de un tiempo, cuando tu proyecto obtenga más atención, presta atención a los problemas y las discusiones.

4. Guidelines for Open Source Success

Short description:

Tu software está siendo utilizado cuando las personas informan problemas y envían solicitudes de extracción. Guía a las personas para categorizar y encontrar problemas de manera eficiente. La reproducción es crucial para corregir errores. GitHub ofrece funciones como etiquetas, hitos y acciones de GitHub. Aprende de los demás, lee el código fuente. Escribe documentación para abordar diferentes casos de uso. Comparte tu proyecto en Twitter, escribe publicaciones de blog y contribuye a Open Source.

Y sabes, tu software está siendo utilizado cuando las personas comienzan a informar problemas y enviar Lo veo como magia cómo simplemente pones algo en GitHub y personas de todo el mundo vienen a ti y encuentran problemas o envían una solicitud de extracción. Y es muy importante guiar a las personas sobre cómo categorizar y encontrar problemas de manera eficiente. Y la reproducción es la más importante. Porque sin reproducción es muy difícil para el mantenedor corregir errores. Y hay muchas otras funciones de GitHub que te facilitan trabajar con código abierto, como etiquetas, hitos y GitHub actions.

El siguiente consejo es aprender de otros. Hay una famosa cita que dice que un buen artista copia y un gran artista roba. Así que no reinventes la rueda, hay mucho buen software ahí fuera que ya resuelve tu problema, aprende de ellos, lee su código fuente para ver cómo lo hacen. A continuación, debes escribir documentación. Es muy fácil para ti usar tu propio software, pero las personas de todo el mundo tienen casos de uso diferentes y especiales, por eso es importante qué problema intenta resolver tu proyecto. Describe claramente la instalación, el uso y cualquier advertencia que puedan encontrar en el documento. Si prefieres React, puedes usar DocuSource. Si prefieres Vue, puedes usar Vitepress. Ambos te ayudarán a crear documentación sin esfuerzo.

Y luego, compártelo con el mundo. Compártelo en Twitter, escribe algunas publicaciones de blog y comparte tu proyecto en un evento. Y por último, pero no menos importante, contribuye a Open Source hoy. Espero que te diviertas mucho y aprendas mucho haciendo software de código abierto. Así que gracias por tu atención. Si escribes, encuentras y pruebas, prueba JustPreview. Y si te gusta, por favor dale una estrella para apoyarme. Y las diapositivas están disponibles y son de código abierto en redadvance.hung.dev. ¡Gracias!

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

TechLead Conference 2023TechLead Conference 2023
35 min
A Framework for Managing Technical Debt
Let’s face it: technical debt is inevitable and rewriting your code every 6 months is not an option. Refactoring is a complex topic that doesn't have a one-size-fits-all solution. Frontend applications are particularly sensitive because of frequent requirements and user flows changes. New abstractions, updated patterns and cleaning up those old functions - it all sounds great on paper, but it often fails in practice: todos accumulate, tickets end up rotting in the backlog and legacy code crops up in every corner of your codebase. So a process of continuous refactoring is the only weapon you have against tech debt.In the past three years, I’ve been exploring different strategies and processes for refactoring code. In this talk I will describe the key components of a framework for tackling refactoring and I will share some of the learnings accumulated along the way. Hopefully, this will help you in your quest of improving the code quality of your codebases.

React Summit 2023React Summit 2023
24 min
Debugging JS
As developers, we spend much of our time debugging apps - often code we didn't even write. Sadly, few developers have ever been taught how to approach debugging - it's something most of us learn through painful experience.  The good news is you _can_ learn how to debug effectively, and there's several key techniques and tools you can use for debugging JS and React apps.
React Advanced Conference 2022React Advanced Conference 2022
22 min
Monolith to Micro-Frontends
Top Content
Many companies worldwide are considering adopting Micro-Frontends to improve business agility and scale, however, there are many unknowns when it comes to what the migration path looks like in practice. In this talk, I will discuss the steps required to successfully migrate a monolithic React Application into a more modular decoupled frontend architecture.
React Advanced Conference 2023React Advanced Conference 2023
22 min
Power Fixing React Performance Woes
Next.js and other wrapping React frameworks provide great power in building larger applications. But with great power comes great performance responsibility - and if you don’t pay attention, it’s easy to add multiple seconds of loading penalty on all of your pages. Eek! Let’s walk through a case study of how a few hours of performance debugging improved both load and parse times for the Centered app by several hundred percent each. We’ll learn not just why those performance problems happen, but how to diagnose and fix them. Hooray, performance! ⚡️
React Summit 2023React Summit 2023
24 min
Video Editing in the Browser
Video editing is a booming market with influencers being all the rage with Reels, TikTok, Youtube. Did you know that browsers now have all the APIs to do video editing in the browser? In this talk I'm going to give you a primer on how video encoding works and how to make it work within the browser. Spoiler, it's not trivial!

Workshops on related topic

React Summit Remote Edition 2021React Summit Remote Edition 2021
87 min
Building a Shopify App with React & Node
Top Content
WorkshopFree
Shopify merchants have a diverse set of needs, and developers have a unique opportunity to meet those needs building apps. Building an app can be tough work but Shopify has created a set of tools and resources to help you build out a seamless app experience as quickly as possible. Get hands on experience building an embedded Shopify app using the Shopify App CLI, Polaris and Shopify App Bridge.We’ll show you how to create an app that accesses information from a development store and can run in your local environment.
JSNation 2022JSNation 2022
41 min
Build a chat room with Appwrite and React
WorkshopFree
API's/Backends are difficult and we need websockets. You will be using VS Code as your editor, Parcel.js, Chakra-ui, React, React Icons, and Appwrite. By the end of this workshop, you will have the knowledge to build a real-time app using Appwrite and zero API development. Follow along and you'll have an awesome chat app to show off!
GraphQL Galaxy 2021GraphQL Galaxy 2021
164 min
Hard GraphQL Problems at Shopify
WorkshopFree
At Shopify scale, we solve some pretty hard problems. In this workshop, five different speakers will outline some of the challenges we’ve faced, and how we’ve overcome them.

Table of contents:
1 - The infamous "N+1" problem: Jonathan Baker - Let's talk about what it is, why it is a problem, and how Shopify handles it at scale across several GraphQL APIs.
2 - Contextualizing GraphQL APIs: Alex Ackerman - How and why we decided to use directives. I’ll share what directives are, which directives are available out of the box, and how to create custom directives.
3 - Faster GraphQL queries for mobile clients: Theo Ben Hassen - As your mobile app grows, so will your GraphQL queries. In this talk, I will go over diverse strategies to make your queries faster and more effective.
4 - Building tomorrow’s product today: Greg MacWilliam - How Shopify adopts future features in today’s code.
5 - Managing large APIs effectively: Rebecca Friedman - We have thousands of developers at Shopify. Let’s take a look at how we’re ensuring the quality and consistency of our GraphQL APIs with so many contributors.
JSNation 2023JSNation 2023
57 min
0 To Auth In An Hour For Your JavaScript App
WorkshopFree
Passwordless authentication may seem complex, but it is simple to add it to any app using the right tool.
We will enhance a full-stack JS application (Node.js backend + Vanilla JS frontend) to authenticate users with One Time Passwords (email) and OAuth, including:
- User authentication – Managing user interactions, returning session / refresh JWTs- Session management and validation – Storing the session securely for subsequent client requests, validating / refreshing sessions
At the end of the workshop, we will also touch on another approach to code authentication using frontend Descope Flows (drag-and-drop workflows), while keeping only session validation in the backend. With this, we will also show how easy it is to enable biometrics and other passwordless authentication methods.
Node Congress 2023Node Congress 2023
85 min
Node.js: Landing your first Open Source contribution & how the Node.js project works
Workshop
This workshop aims to give you an introductory module on the general aspects of Open Source. Follow Claudio Wunder from the OpenJS Foundation to guide you on how the governance model of Node.js work, how high-level decisions are made, and how to land your very first contribution. At the end of the workshop, you'll have a general understanding of all the kinds of work that the Node.js project does (From Bug triage to deciding the Next-10 years of Node.js) and how you can be part of the bigger picture of the JavaScript ecosystem.

The following technologies and soft skills might be needed):
  - Basic understanding of Git & GitHub interface
  - Professional/Intermediate English knowledge for communication and for allowing you to contribute to the Node.js org (As all contributions require communication within GitHub Issues/PRs)
  - The workshop requires you to have a computer (Otherwise, it becomes difficult to collaborate, but tablets are also OK) with an IDE setup, and we recommend VS Code and we recommend the GitHub Pull Requests & Issues Extension for collaborating with Issues and Pull Requests straight from the IDE.

The following themes will be covered during the workshop:
- A recap of some of GitHub UI features, such as GitHub projects and GitHub Issues
- We will cover the basics of Open Source and go through Open Source Guide
- We will recap Markdown
- We will cover Open Source governance and how the Node.js project works and talk about the OpenJS Foundation
  - Including all the ways one might contribute to the Node.js project and how their contributions can be valued
- During this Workshop, we will cover Issues from the nodejs/nodejs.dev as most of them are entry-level and do not require C++ or deep technical knowledge of Node.js.
  - Having that said, we still recommend enthusiast attendees that want to challenge themselves to "Good First Issues" from the nodejs/node (core repository) if they wish.
  - We're going to allow each attendee to choose an issue or to sit together with other attendees and tackle issues together with Pair Programming through VS Code Live Share feature
    - We can also do Zoom breakrooms for people that want to collaborate together
  - Claudio will be there to give support to all attendees and, of course, answer any questions regarding Issues and technical challenges they might face
  - The technologies used within nodejs/nodejs.dev are React/JSX, Markdown, MDX and Gatsby. (No need any knowledge of Gatsby, as most of the issues are platform agnostic)
- By the end of the Workshop, we'll collect all (make a list) the contributors who successfully opened a Pull Request (even if it's a draft) and recognise their participation on Social media.