Hábitos y principios para el desarrollo de proyectos open source Nahuel Garbezza (@ngarbezza)

Un poco sobre mí Desarrollador de software saludable y líder de equipo en 10Pines 󰎆 Licenciado en Informática (UNQ 󰎆) Docente de programación orientada a objetos Me gustan los lenguajes dinámicos, desarrollar con TDD, escribir y dar charlas

Caso de estudio Testy: https://github.com/ngarbezza/testy Herramienta de testing minimalista en Javascript, diseñada para aprender a testear y a hacer TDD. Diseñada durante la cursada 2018 de Programación Orientada a Objetos 2 (UCA 󰎆)

4 principios para proyectos saludables 1⃣ software abierto 2⃣ construcción de comunidad 3⃣ software simple 4⃣ feedback siempre presente

Pero antes de empezar recordemos... … lo que nos invita la agilidad: 󰗓 adaptarnos a los cambios, que implica… 󰗓 definir nuevos principios / redefinir existentes, que implica… 󰗓 aprender más y mejor

Principio #1: software abierto ¿abierto == open source?

Software abierto código disponible + información para comprender el proyecto y su visión + guías de instalación, uso y contribución

Hábitos para tener un software más abierto 󰙤 Mantener un README como lugar centralizado de información 👀 Curso Tech Writing https://developers.google.com/tech-writing 👀 Readme-Driven Development https://tom.preston-werner.com/2010/08/23/rea dme-driven-development.html

Hábitos para tener un software más abierto 󰙤 Escribir guías de contribución y registro de cambios (changelog) 👀 Versionado semántico https://semver.org/lang/es/ 👀 Keep a changelog https://keepachangelog.com/es-ES/1.0.0/

Hábitos para tener un software más abierto 󰙤 Mantener un backlog categorizado y detallado

Hábitos para tener un software más abierto 󰙤 Documentar decisiones importantes 👀 Architectural Decision Records (ADR) - https://adr.github.io/

Principio #2: construcción de una comunidad Recordemos que hacer software es una actividad social

Hábitos para construir una comunidad 󰙤 Involucrarse en eventos y comunidades de tecnología 👀 Hacktoberfest https://hacktoberfest.digitalocean.com/

Hábitos para construir una comunidad 󰙤 Reconocer y agradecer a contribuyentes 👀 All Contributors https://allcontributors.org/

Principio #3: software simple Lidiamos con la complejidad esencial, evitamos la complejidad accidental

Hábitos para escribir software más simple 󰙤 Evitar abstracciones innecesarias, no anticiparnos a la evolución del diseño 👀 KISS, YAGNI

Hábitos para escribir software más simple 󰙤 pagar deuda técnica lo más pronto posible, de a poco y seguido

Hábitos para escribir software más simple 󰙤 Pensar 3 veces antes de agregar una dependencia

Hábitos para escribir software más simple 󰙤 Analizar la complejidad constantemente 👀 CodeClimate (gratuito para proyectos públicos) 👀 Madge https://github.com/pahen/madge

Principio #3: feedback siempre presente Aprendemos más y mejor con ciclos cortos de feedback

Hábitos para lograr feedback más rápido 󰙤 Lanzar mensajes de error completos 👀 Responder a las preguntas: ¿Cuál es el problema? ¿Dónde ocurrió? ¿Fue un error interno o un problema con algo que hice como usuari@? ¿Cómo podría solucionarlo?

Hábitos para lograr feedback más rápido 󰙤 Generar ejemplos

Hábitos para lograr feedback más rápido 󰙤 Medir mejoras en cada cambio

Lectura recomendada “Design Principles Behind Smalltalk” https://www.cs.virginia.edu/~evans/cs655/readings/smalltalk.html Dan Ingalls, 1981

Conclusiones ● Desarrollar open source es más que poner código públicamente ● Desarrollamos siempre en comunidad ● Identificar hábitos saludables y practicarlos ● Muchos de los hábitos los reforzamos realizando TDD ● Nunca perder de vista tus principios ○ Ante un cambio, pensar: que nos acerca y que nos aleja de cumplir con los principios?

¡Muchas gracias! @ngarbezza https://blog.10pines.com/author/nahuel https://ngarbezza.com.ar