Skip to content

Commit 4fa7ab6

Browse files
Oscar LobatonOscar Lobaton
authored andcommitted
Add Spanish templates for README and CONTRIBUTING documentation
1 parent e5156fe commit 4fa7ab6

28 files changed

+2853
-1
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Title
2+
3+
Garantía de 30 Días
4+
5+
## Resumen
6+
7+
Al aceptar contribuciones de fuera de tu propio equipo, existe una aversión natural a asumir la responsabilidad del código no escrito por el equipo mismo. A través de la Garantía de 30 Días, el equipo contribuyente se compromete a proporcionar correcciones de errores al equipo receptor, lo que aumentará el nivel de confianza entre ambos equipos y hace más probable que se acepten las contribuciones.
8+
9+
## Problema
10+
11+
Un equipo desarrolla un componente que se utiliza en toda una organización. Este equipo se resiste a aceptar o directamente rechaza contribuciones (solicitudes de funcionalidades). Este comportamiento bloquea el progreso y conduce a interrupciones frecuentes por escalamientos.
12+
13+
## Contexto
14+
15+
- Los equipos dependen de que otro equipo acepte sus contribuciones para que un componente producido por el equipo receptor pueda ser utilizado por el equipo contribuyente.
16+
- El equipo receptor no tiene los recursos, conocimientos, permisos y/o inclinación para escribir el componente/funcionalidad contribuido por sí mismos.
17+
18+
## Fuerzas
19+
20+
- Existe desconfianza hacia las contribuciones debido a un historial de engaños: los equipos enviaron contribuciones a medio terminar y posteriormente presentaron solicitudes de correcciones para hacerlas listas para su uso en producción.
21+
- Si el código es contribuido desde fuera del equipo, el equipo tiene la sospecha natural de que el otro equipo no sabe cómo escribir código que cumpla con las expectativas del equipo receptor.
22+
- Cada equipo busca primero ayudar a sus propios líderes a alcanzar sus objetivos. Esta dirección de lealtad puede complicar la resolución de este problema.
23+
- Existe una aversión natural a asumir la responsabilidad del código no escrito por uno mismo.
24+
- El código contribuido necesita ser reescrito considerablemente antes de ser aceptado en la base de código.
25+
- Existe el temor de que los contribuyentes no estén disponibles para el soporte en la corrección de errores después del momento de la contribución.
26+
- Los equipos temen que el código contribuido lleve a costos de mantenimiento más altos pero no saben cómo controlarlo.
27+
- Los equipos receptores pueden temer que enseñar a otros cómo contribuir código expondrá deuda técnica en su sistema y que esa visibilidad pueda ser dañina.
28+
- Los equipos receptores pueden no creer que recibirán código aceptable sin importar cuánta tutoría proporcionen.
29+
- Cualquiera de los equipos puede no sentirse seguro al medir riesgos o certificar que están mitigados en una contribución; el sistema en sí es algo frágil (puede no haber formas de probar completamente y detectar todos los problemas).
30+
31+
## Solución
32+
33+
Aborda los temores de ambos equipos, tanto el receptor como el contribuyente, estableciendo un **período de garantía de 30 días** que comienza cuando el código contribuido entra en producción. Durante este período de garantía, el equipo contribuyente acepta proporcionar correcciones de errores al equipo receptor.
34+
35+
Ten en cuenta que el período de garantía podría ser de 45, 60 o 100 días también. La duración puede variar según las restricciones del proyecto, el ciclo de vida del software del proyecto, los compromisos con los clientes y otros factores.
36+
37+
Además, ayuda proporcionar [directrices de contribución](./base-documentation.md) claras, detallando las expectativas tanto del equipo receptor como del equipo contribuyente.
38+
39+
![Garantía de 30 Días](../../../assets/img/thirtydaywarranty.jpg)
40+
41+
## Contexto Resultante
42+
43+
- El equipo receptor está dispuesto a aceptar contribuciones y puede compartir la carga de trabajo de adaptaciones/correcciones iniciales.
44+
- Mayor transparencia y equidad.
45+
- Evita que los escalamientos se vuelvan demasiado pesados.
46+
47+
## Instancias Conocidas
48+
49+
- Esto fue probado y demostrado exitoso en PayPal.
50+
- GitHub internamente usa este patrón con un período de garantía modificado de 6 semanas.
51+
- Microsoft recomienda este patrón como principio - los equipos establecen su propio objetivo de tiempo específico que coincida con sus necesidades y confianza.
52+
- SAP aprovecha este patrón en su proyecto Everest basado en InnerSource para transformar la colaboración, asegurando que las contribuciones no solo sean aceptadas sino también apoyadas, mejorando la confianza e impulsando la cultura de responsabilidad compartida e innovación. Ver: [InnerSource: Primera Contribución Explorada](https://community.sap.com/t5/open-source-blogs/innersource-first-contribution-explored/ba-p/13644916)
53+
54+
## Autores
55+
56+
- Cedric Williams
57+
58+
## Agradecimientos
59+
60+
- Dirk-Willem van Gulik
61+
- Padma Sudarsan
62+
- Klaas-Jan Stol
63+
- Georg Grütter
64+
65+
## Estado
66+
67+
* Estructurado
68+
* Redactado en la Cumbre InnerSource de Primavera 2017; revisado el 18 de julio de 2017.
69+
70+
## Variantes
71+
72+
- Asegurar la cooperación de equipos dependientes convirtiéndolos en una comunidad al tener más de un "[Trusted Committer](./trusted-committer.md)" (TC) designado meritocráticamente que asuma la responsabilidad.
73+
74+
75+
## Histórico de Traducciones
76+
77+
- **2025-04-03** - Tradución [Oscar Lobaton S.](https://github.com/ovas04)
Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
## Title
2+
3+
Documentación Base Estándar
4+
5+
## Resumen
6+
7+
Los nuevos contribuidores a un proyecto InnerSource tienen dificultades para identificar quién
8+
mantiene el proyecto, en qué trabajar y cómo contribuir. Proporcionar
9+
documentación en archivos estándar como `README.md`/`CONTRIBUTING.md`/`COMMUNICATION.md` permite un
10+
proceso de autoservicio para nuevos contribuidores, permitiéndoles encontrar respuestas a
11+
las preguntas más comunes por sí mismos.
12+
13+
## Problema
14+
15+
Un equipo desea compartir un proyecto, ya sea nuevo o existente, con
16+
la organización y recibir contribuciones. Los potenciales contribuidores
17+
frecuentemente se sienten perdidos: No logran identificar los canales de comunicación
18+
preferidos del equipo. Tienen dificultades para determinar rápidamente si una nueva
19+
funcionalidad tiene sentido o no. Les cuesta entender exactamente
20+
quiénes son los colegas que actualmente mantienen el proyecto.
21+
22+
## Contexto
23+
24+
Un proyecto se compartirá con otros como proyecto InnerSource. Para que
25+
otros puedan entender de qué trata el proyecto y cómo
26+
contribuir, el proyecto necesita proporcionar documentación básica. Hasta ahora,
27+
el proyecto carece de toda la documentación o algunos aspectos necesarios para que los usuarios
28+
lo prueben de manera autónoma y para que los contribuidores puedan ponerse al día
29+
rápidamente.
30+
31+
## Fuerzas
32+
33+
- El proyecto se convirtió en un proyecto InnerSource recientemente. Antes, los usuarios eran internos o recibían capacitación presencial. De igual manera, las personas que trabajaban en el proyecto pasaban por sesiones de incorporación presencial que no son escalables con el crecimiento de contribuidores o contribuidores remotos. Como resultado, falta documentación de autoservicio.
34+
- El proyecto fue creado como un proyecto InnerSource, pero el equipo anfitrión carece de experiencia con InnerSource. Como resultado, necesitan orientación sobre qué información incluir en su documentación, dónde ubicarla para que otros la encuentren y qué tipos de lectores considerar.
35+
- El proyecto se convirtió en un proyecto InnerSource recientemente, y el equipo anfitrión tiene experiencia limitada con InnerSource. Como resultado, la documentación existente aborda aspectos técnicos pero no cubre comunicación, coordinación e información necesaria para facilitar la planificación transparente.
36+
- El proyecto se convirtió en un proyecto InnerSource recientemente. Como resultado, mucho conocimiento implícito del equipo no está documentado ni es obvio para los contribuidores.
37+
- La falta de documentación hace que los potenciales contribuidores tarden mucho en configurar y comenzar. Producir documentación (y mantenerla actualizada) requiere inversión de tiempo. Incluso si el equipo anfitrión cuenta con contribuidores para ayudar con la documentación faltante, esas contribuciones necesitan tiempo de revisión.
38+
- Los miembros del proyecto dedican mucho tiempo a responder preguntas iniciales. Mantener una base de datos completa de preguntas de soporte requiere mucho tiempo y esfuerzo.
39+
- Diferentes equipos dentro de la organización tienen estándares divergentes sobre cómo formatear código y qué patrones de software usar. Como resultado, las contribuciones a menudo terminan siendo reescritas en gran parte o completamente. Estandarizar todo esto requeriría mucho tiempo y trabajo.
40+
- El trabajo adicional por explicaciones repetidas y reescrituras disminuye la utilidad del enfoque InnerSource.
41+
- Las escalaciones frecuentes debido al trabajo extra y los retrasos por reescrituras llevan a una situación de cuello de botella.
42+
43+
## Solución
44+
45+
Abordar la necesidad de una documentación más clara para nuevos contribuidores. El objetivo al
46+
crear esta documentación debe ser hacer que el proceso de inicio sea lo más autoservicio posible, con preguntas frecuentes respondidas en un formato de documentación estándar.
47+
48+
### README.md
49+
50+
Si aún no existe, crea un `README.md` para tu proyecto. Debe contener:
51+
52+
* La [misión del proyecto](https://producingoss.com/en/producingoss.html#mission-statement) en un formato lo más conciso posible. Debe responder cuál es el propósito del proyecto y permitir a los contribuidores hacer una buena suposición inicial sobre si una funcionalidad sugerida probablemente estará dentro del alcance del proyecto o no.
53+
* Una sección de "Primeros pasos" para los usuarios del proyecto. Debe explicar cómo configurar/integrar los artefactos del proyecto, así como una explicación de algunos de los primeros pasos típicos para los usuarios primerizos.
54+
* Documentación más profunda para los usuarios del proyecto, o un enlace a ella.
55+
* Documentación necesaria para hacer modificaciones al proyecto, o un enlace a ella.
56+
* Documentación sobre cómo contribuir al proyecto, o un enlace a ella.
57+
* Una sección de "Participar" que explique qué canales de comunicación públicos, archivados y enlazables utiliza el proyecto. Esto debe incluir un enlace al rastreador de problemas del proyecto, pero también a cualquier otro medio de discusión utilizado.
58+
* Una sección de "Quiénes somos" que explique quiénes son los [Trusted Committers](trusted-committer.md) detrás del proyecto, con una explicación de que en lugar de contactar a estas personas en privado, se deben utilizar los canales de comunicación públicos mencionados anteriormente.
59+
* Una explicación de cuáles son los criterios para que el proyecto convierta a los contribuidores en Trusted Committers, si ese camino existe.
60+
61+
![README.md](../../../assets/img/standard-base-documentation/README-for-users.png)
62+
63+
### CONTRIBUTING.md
64+
65+
Si la explicación de los pasos para hacer una contribución es demasiado detallada, crea
66+
un documento `CONTRIBUTING.md` separado. Este documento debe responder preguntas frecuentes que los contribuidores hayan hecho en el pasado. No es necesario proporcionar un libro completo desde el principio. Más bien, comparte información que haya demostrado ser necesaria para los contribuidores. Probablemente tocará uno o más de los siguientes temas:
67+
68+
* Cómo obtener el código fuente del proyecto desde el control de versiones.
69+
* Cómo hacer modificaciones al proyecto (potencialmente incluyendo información sobre las pautas de codificación).
70+
* Cómo construir el proyecto.
71+
* Cómo ejecutar pruebas para asegurarse de que las modificaciones anteriores no introduzcan nuevos errores.
72+
* Cómo enviar tus modificaciones de vuelta al proyecto.
73+
* Alguna información sobre el tiempo de respuesta esperado para las modificaciones realizadas.
74+
75+
![CONTRIBUTING.md](../../../assets/img/standard-base-documentation/CONTRIBUTING-for-contributors.png)
76+
77+
78+
### COMMUNICATION.md
79+
80+
Crea un documento `COMMUNICATION.md` separado. Enlaza este documento a tu `README.md` para que se pueda proporcionar información de contacto completa sin ocupar espacio adicional en tu README. Este documento debe responder preguntas frecuentes sobre cómo comunicarse con tu equipo que los contribuidores necesitan saber. El objetivo es agilizar las comunicaciones para que los usuarios y contribuidores se comuniquen con la persona correcta a través de un solo canal. Esto reduce distracciones innecesarias para los miembros del equipo y organiza las comunicaciones para que no se pierdan.
81+
82+
Las secciones en el `COMMUNICATION.md` incluyen puntos de contacto para comunicaciones entrantes e información sobre comunicaciones salientes del equipo de propiedad del proyecto. A continuación, algunos ejemplos.
83+
84+
Puntos de contacto para la comunicación entrante y cómo contactar a esos usuarios:
85+
86+
* Reportar un error
87+
* Dar seguimiento a un PR
88+
* Solicitudes de funcionalidades
89+
* Preguntas sobre documentación
90+
* Escalaciones
91+
92+
Cómo y cuándo el equipo se comunica con los usuarios y cómo ser agregado a esas comunicaciones:
93+
94+
* Interrupciones planificadas y no planificadas
95+
* Lanzamientos de funcionalidades
96+
* Congelaciones de código
97+
* Cambios importantes
98+
99+
Hay muchos buenos ejemplos de cómo escribir un `README.md` y qué tipo
100+
de información incluir en un archivo `CONTRIBUTING.md` en varios proyectos de código abierto.
101+
Páginas como [cómo escribir un readme que destaque](https://m.dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a),
102+
[Guía de Código Abierto de GitHub](https://opensource.guide/) así como
103+
el libro [Producing Open Source](https://producingoss.com/en/producingoss.html)
104+
tienen información valiosa sobre qué tipo de información proporcionar. Aunque
105+
Producing Open Source no tiene un capítulo sobre cómo escribir un buen README per se,
106+
el [capítulo de Primeros Pasos](https://producingoss.com/en/producingoss.html#starting-from-what-you-have)
107+
proporciona una lista bastante extensa de cosas que los miembros del equipo anfitrión,
108+
usuarios y contribuidores necesitarán. Los proyectos InnerSource probablemente no cubrirán todos
109+
esos aspectos desde el principio, pero la lista en sí es útil para
110+
inspiración sobre qué se podría cubrir.
111+
112+
Además de eso, este patrón viene con tres plantillas muy básicas para que
113+
puedas comenzar de inmediato: [README-template.md](templates/README-template.md),
114+
[CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md) y [COMMUNICATION-template.md](templates/COMMUNICATION-template.md).
115+
116+
## Contexto Resultante
117+
118+
* El tiempo para que los contribuidores se pongan al día se reduce significativamente.
119+
* El tiempo dedicado a responder preguntas iniciales para los [Trusted Committers](trusted-committer.md) se reduce significativamente, dejándoles más tiempo para trabajar en otras tareas.
120+
* Las escalaciones debido a malentendidos y desalineaciones se reducen significativamente.
121+
122+
## Instancias Conocidas
123+
124+
* Europace AG - Ver publicación en el blog [InnerSource: Adding base documentation](https://tech.europace.de/post/innersource-base-documentation/)
125+
* Paypal Inc.
126+
* Mercado Libre - crear un sitio de documentación que contenga cómo comenzar con InnerSource y también definir los artefactos básicos que un repositorio debe tener para ser InnerSource (README, CONTRIBUTING, CODING_GUIDELINES, etc).
127+
* Analog Devices Inc.
128+
* Airbus
129+
130+
## Autores
131+
132+
* Isabel Drost-Fromm
133+
* Katie Schueths - agregó el concepto de `COMMUNICATION.md`
134+
135+
## Alias
136+
137+
Proporcionar documentación base estándar a través de un README
138+
139+
## Estado
140+
141+
* Estructurado
142+
* Borrador en diciembre de 2019.
143+
144+
## Referencias
145+
146+
* [README-template.md](templates/README-template.md)
147+
* [CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md)
148+
* [COMMUNICATION-template.md](templates/COMMUNICATION-template.md)
149+
150+
## Créditos
151+
152+
Ilustraciones de [Web](https://storyset.com/web) y [People](https://storyset.com/people) por Storyset
153+
154+
## Histórico de Traducciones
155+
156+
- **2025-04-03** - Tradución [Oscar Lobaton S.](https://github.com/ovas04)

0 commit comments

Comments
 (0)