Ir al contenido principal
Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Contribución a la Documentación

Qué cambiar y por qué

La documentación evoluciona rápidamente y está en constante cambio. Por favor, reflexiona detenidamente sobre qué estás modificando y por qué; ¿qué contribución aportará a futuro? Las reescrituras extensas y las nuevas páginas deben evaluarse con mucho cuidado y coordinarse en nuestra sala Matrix de documentación.

Realiza una Autorevisión

Antes de finalizar tus cambios, por favor, sé cortés con los revisores y ejecuta tus cambios, al menos, a través de un corrector ortográfico (por ejemplo, apsell) y posiblemente un corrector gramatical. Está bien usar IA para esto, pero úsala con moderación para generar contenido. Asegúrate de releer lo que resulte y ajusta según sea necesario. Apreciamos los estilos de escritura individuales, pero la mayor parte de nuestra revisión va y viene por problemas menores como estos, así que por favor haz tu parte para que quede bien desde el principio.

Edición Colaborativa entre Pares

Para cambios muy grandes, fomentamos la idea de la edición colaborativa entre pares. En lugar de enviar un PR masivo y luego tener una edición línea por línea con iteraciones de ida y vuelta, sugerimos colocar tu documento nuevo o actualizado en un editor de documentos colaborativo como HackMD y compartirlo en nuestra sala Matrix de documentación. Así podrás, entre el chat y el editor colaborativo, obtener una edición línea por línea de ortografía, gramática y formato, sin ida y vuelta en el PR. Una vez que ambas partes estén satisfechas con los cambios, se puede enviar un pull request.

Aunque pueda parecer "más trabajo", para cambios sustanciales esto debería ser una parte menor del proceso total y ayudará a que las revisiones finales sean más fluidas.

Revisiones entre Pares

Debido al volumen de pull requests en nuestro repositorio de documentación y sus diferentes tamaños, algunos PRs tardarán mucho en revisarse y potencialmente quedarán estancados.

Antes (o inmediatamente después) de enviar un PR para revisión, te pedimos que encuentres otro PR de otra persona, idealmente uno sin revisión previa por pares o el equipo, y realices una lectura exhaustiva de los cambios. Verifica que tengan sentido para ti, que la redacción sea buena y proporciona una revisión en GitHub. Si es necesario, señala sugerencias de cambios. Esto ayudará enormemente a que revisen tu PR, pues el siguiente contribuidor podrá revisar el tuyo a cambio.

Publicaciones de Blog

Las publicaciones de blog son escritas exclusivamente por miembros de nuestro equipo; no aceptamos contribuciones externas bajo ninguna circunstancia. Las entradas de blog deben seguir todos los procesos anteriores y además requieren aprobación final del equipo Core además de los aprobadores regulares de documentación. Las publicaciones pueden permanecer en estado de borrador o revisión durante algún tiempo, hasta el evento al que correspondan (ej. un lanzamiento); la fecha debe reflejar siempre la fecha de publicación final (esperada).