Desmitificando el Mantenimiento- DjangoCon US

Transcript

1. Desmitificando el Mantenimiento By Katherine “Kati” Michel
2. Mis Afiliaciones 2
3. Objetivos de la Charla • Fundamentos del mantenimiento • Un caso de estudio: Sitio Web de DjangoCon US • Un caso de estudio: Pinax • Lecciones aprendidas
4. Supuestos Entiendes: • Los fundamentos de usar GitHub • Los fundamentos de contribuir
5. Iniciandonos en la Colaboración y la Revisión de Código en GitHub
6. Vocabulario: GitHub Documentación en Español https://docs.github.com/es
7. Terminología de GitHub • Repo, branch • Fork, clone, commit, submit • Issue, pull request (PR) • Fetch, push, update, merge, delete • Community health files, templates • Change log
8. El mantenimiento no es sólo acerca de código Es también sobre: • Personas • Comunidad • Proceso • Comunicación • Amabilidad
9. Intenta ponerte en los zapatos del colaborador Haz del proceso de contribución lo más fácil posible
10. GitHub Guías de Código Abierto: “Una Lista de Verificación Antes de Contribuir”
11. Algunos Signos de un Proyecto Saludable • Hay un ambiente de bienvenida • Hay actividad reciente • Los mantenedores responden rápidamente • Los mantenedores reducen issues/pull requests
12. Proceso Ideal Para futuros colaboradores: • Encontrar un proyecto • Estar de acuerdo con el Código de Conducta • Lee el archivo CONTRIBUTING.md • Usa docs, issue/pull request templates • Submit issue/pull request • El mantenedor responde rápidamente
13. Community Health Files README.md CODE_OF_CONDUCT.md LICENSE CONTRIBUTING.md
14. Documentación • Muy valorado • Usualmente se pasa por alto • Es un medio para establecer comunidades inclusivas y accesibles -De la encuesta sobre código abierto de GitHub de 2017
15. Cómo Los Colaboradores Contribuyen
16. Modelo de Repo Compartido Repo del sitio web de DjangoCon US Hace push a las branches, crea pull requests Puede hacer push o pull gracias al “write permission”, no necesitas hacer fork Clonar Entorno de desarrollo
17. Modelo de Fork y Pull Repo del sitio web de DjangoCon US Fork Submit pull request Push cambios, incluyendo branches Entorno de desarrollo
18. Crear un Pull Request DjangoCon US Sitio Web Repo Crear un Nuevo Pull Request Título y descripción Crear Elige branches
19. Revisando un Pull Request Revisa los cambios Título y descripción
20. Revisando un Pull Request Botón de Merge Instrucciones de linea de comando Revisa los cambios Título y descripción
21. Pull Request: Línea Comando
22. Pull Request: Opciones Si No Ejecutas el Código Localmente • Si no se necesita ningún cambio o el cambio se puede hacer en el navegador • Realice el cambio en el navegador • Haga clic en merge
23. Pull Request: Opciones Si Ejecutas el Código Localmente • Si no se necesita ningún cambio, vuelve al navegador y haz clic en merge • Si se necesita un cambio, pídale al colaborador que lo haga, o submit mismo la actualización, y luego haga clic en merge
24. Pull Request: Comandos Branch en un Repo Compartido Branch en un Forked Repo $ git fetch origin $ git checkout -b <branch-name> origin/<branch-name> $ git merge main $ git push origin <branch-name> $ git checkout -b <branch-name> main $ git pull https://github.com/<user-name>/<repo-name> <branch-name> $ git push https://github.com/<user-name>/<repo-name> <branch-name>
25. Flujo de Trabajo: GitHub Flow Main Branch Live Production Site Pull Requests
26. Flujo de Trabajo: Variación Main Branch Live Production Site Pull Requests Staging Site Dev Branch
27. Algunas Recomendaciones
28. Licencias • Licencias no copyleft • Licencias Copyleft • Licencias éticas • GitHub “Choose a License” (Elija una Licencia)
29. Seguridad • Software supply chain • Nivel individual (2FA, acceso limitado) • Nivel organizacional (secreto y dependencia scanning) • Nivel de proyecto (releases nuevas, security plan)
30. CHAOSS: Métricas de Código Abierto para Evaluar la Salud de Tu Proyecto
31. Más Funciones Útiles de GitHub • Issue y pull request templates • Global Community Health File Repo • Project Boards, milestones, issues, labels • Wiki, GitHub Pages/Jekyll • Labels/triaging, topics, publicaciones de blog
32. Un Caso de Estudio: Sitio Web de DjangoCon US
33. Puntos Clave Una oportunidad para: • Aprender los fundamentos de mantenimiento • Crecer en una comunidad de colaboradores
34. DjangoCon US: La Conferencia Con Un Corazón
35. Los Sitios que He Supervisado
36. Los Pull Requests Más Fácil 67 commits, incluyendo merging 28 pull requests
37. • Hacer fetch a un pull request localmente • Ejecutar el código • Hacer push a una actualización desde un fork a un pull request • Hacer merge a un pull request localmente • Hacer push a un pull request a una `main` branch Yo aprendí como...
38. Aumento en el Número de Colaboradores De 23 en 2016 A la 65 en 2020
39. Creé docs para los colaboradores y ayudé a los principiantes Me Convertí en Mentor
40. Algunas Lecciones Aprendidas del Sitio Web de DjangoCon US
41. Seguridad Psicológica • Es ideal aprender en un ambiente que ofrece seguridad psicológica
42. Los Errores Desaparecen en el Historial de Git • Está bien tener una mentalidad de principiante; cometer errores, seguir mejorando
43. La Perspectiva del Principiante es Valiosa • Los veteranos del proyecto no pueden verlo con los ojos de un principiante • Mejorar el proyecto para la próxima persona • Por ejemplo: crear docs de instalación
44. Logrando Resultados 10x 10x habilidades que no involucrar escribir código • Mantener los docs • Hacerle publicidad al proyecto • Ser mentor de los colaboradores
45. Mi Primera Charla Tech Foto de Adam Gregory de https://atomimages509.wixsite.com/atom
46. Un Caso de Estudio: Pinax
47. Vocabulario de Pinax • Pinax Starter Project es un Proyecto de Inicio de Pinax • Pinax app es una aplicación Pinax • Pinax CLI (Command line interface) es una interfaz de línea de comandos • Pinax Themes son Temas Pinax
48. Vocabulario de Testing • Test es prueba • Test matrix es matriz de pruebas • Continuous integration es integración continua
49. Vocabulario de Packaging • Package es paquete • Release notes son notas de versión • Tag es etiqueta • Publish es publicar
50. Puntos Clave Una oportunidad para: • Mantener una librería compleja de Django • Convertirte en un Python package release manager • Aprenda a lidiar con el síndrome de lavadero
51. Fui Contratado por Eldarion para Mantener Pinax Pinax: una librería de código abierto de Starter Projects, apps y temas reutilizables de Django para crear sitios web
52. Nació Pinax: 2008
53. Cómo Comenzó Sitios Personales Inspiran Funciones Reutilizables
54. Cómo Comenzó “Pinax es todas las ideas que he tenido.”
55. Cómo Iba 80 Proyectos y Apps account blog static stripe waitinglist zero company documents team-wiki wiki forums socialauth Pinax Themes Popular Pinax Apps Pinax Starter Projects django-user-accounts pinax-stripe pinax-announcements pinax-badges pinax-blog pinax-calendars pinax-cohorts pinax-comments pinax-documents pinax-eventlog pinax-events pinax-forums pinax-images pinax-invitations pinax-likes pinax-messages pinax-news pinax-notifications pinax-points pinax-ratings pinax-referrals pinax-submissions pinax-teams pinax-testimonials pinax-types pinax-waitinglist pinax-webanalytics pinax-wiki pinax-templates pinax-theme-bootstrap
56. Cómo Iba Faltaba la Sostenibilidad
57. Cómo Iba GitHub Organización, Global Docs, y Slack
58. Tradicional Proyecto Django Proyecto Archivos Terminal $ django-admin startproject misito .
59. Tradicional Django Apps Proyecto y App Archivos Terminal $ python manage.py startapp miapp
60. Pinax CLI Terminal $ pip install pinax-cli $ pinax projects
61. Pinax CLI Django llama `startproject` desde el base de código de pinax-cli Fragmento de Código
62. Pinax CLI Fragmento de Código El URL del starter project se pasa como un parámetro
63. Archivo`projects.json` Fragmento de Archivo
64. Pinax Starter Projects • Los starter projects están en uno repo • Cada starter project está en una branch individual
65. Pinax Apps en Starter Projects Cada starter project contiene las Pinax apps relevantes, para ser instaladas desde PyPI (Python Package Index)
66. Pinax Apps Independiente Alternativamente, puedes usar Pinax apps independiente de cualquier Pinax Starter Project Buscas “pinax” en PyPI
67. Un Release Típico • Actualizar la test matrix • Agregar nuevas funciones • Implementar nuevas mejores prácticas • Arreglar las depreciaciones • Mejorar la documentación
68. Manteniendo Pinax Apps • GitHub Flow flujo de trabajo • CalVer en el release-nivel (año.mes) • SemVer en el aplicación-nivel (major.minor.patch)
69. Pinax App Código Cada Pinax app vive en un GitHub repo
70. Profesional Nivel Configs tox para testing CircleCI para continuous integration `setup.py`para packaging
71. Actualizar la Test Matrix Fragmento de CircleCI Fragmento de tox
72. pyenv y tox Puedes usar pyenv para instalar múltiples versiones de Python globalmente... Entonces tox puede ejecutar la test matrix Terminal
73. Python/Django Release Notes Explicar todos los cambios realizado en el base de código en el release
74. Actualizar SemVer Versión y Change Log
75. Tag y Publish Tagging un release Publicar en PyPI
76. Release 20.07 • 28 apps incluidas • Discontinuamos el soporte para Python 2.7 • Un hito importante para mí, personal y profesionalmente
77. Algunas Lecciones Aprendidas de Pinax
78. Simplificado, Autoservicio, Autosostenible
79. Mejoras Importantes que He Dirigido • Documentación del conocimiento tribal • Consolidation de docs, en un lugar fácil de encontrar • Estandarización de las configuraciones • Creación de docs de release y mantenimiento • Creación de Community Health Files y Templates • Reducción significativa en issues y pull requests
80. La Importancia de Publicidad
81. Agotamiento (Burnout) • Hay un peligro real de agotamiento en código abierto
82. Reducir el Alcance • Marcar repos como obsoletos • Archivar repos • Desactivar issues • Comunicar que los mantenedores mantienen el código esporádicamente
83. Automatización Adicional • GitHub Actions • GitHub Apps • Probot
84. Herramientas Específicas de Python • Coverage.py • Isort • Black • Restructured Text • Y muchos otros
85. Centralizar el Acceso y el Conocimiento • Centralizar el acceso • Estar dispuesto a dar acceso a otras personas • Evitar soluciones que sean muy únicas
86. Gestión de Mantenedores Voluntarios • Dar permisos selectivos • Proteger branches • Requerir revisiones • Usar status checks • Revertir un pull request, si es necesario
87. Pensamientos Finales
88. Cuando Necesites Ayuda • Google • Stack Overflow • GitHub docs • Git docs • Atlassian y GitLab docs
89. Contrato Social de OS “... open source maintainers owe you quite literally nothing when it comes to their open source code, and treating them poorly is unethical.” - Brett Cannon, Python Core Dev
90. Ventajas del mantenimiento • Aprender habilidades técnicas • Encontrar nuevas oportunidades profesionales • Asistir a conferencias • Conocer personas inteligentes e interesantes • Viajar a lugares increíbles
91. Cenar Con Guido Yo Guido
92. Vale la pena? Si :)
93. Vale la pena? Si :)
94. Muchas Gracias :) Gracias a Ricardo Diaz Rincon por revisar mi charla
95. Contactarme :) Katherine “Kati” Michel Email: kthrnmichel@gmail.com Twitter handle: @KatiMichel GitHub username: KatherineMichel
96. Preguntas y Respuestas