Saltar al contenido principal

31. Cómo contribuir a la guía

Esta guía es de la comunidad. Toda persona puede proponer mejoras, desde corregir una errata hasta incorporar un capítulo.

31.1. Tipos de contribución​

  • Corrección de erratas y enlaces rotos.
  • Mejora de explicaciones y ejemplos.
  • Propuestas de nuevas reglas o de cambios de criterio.
  • Ampliación de glosarios y de la lista de falsos amigos.
  • Aportación de perfiles de estilo de proyectos reales como ejemplo.
  • Traducción o adaptación a otros contextos.

31.2. Flujo de trabajo en el repositorio​

  1. Buscar si ya existe una incidencia o una propuesta similar.
  2. Abrir una incidencia para los cambios de criterio o las novedades de calado; para erratas basta con una propuesta directa.
  3. Bifurcar (fork) el repositorio y crear una rama con un nombre descriptivo (fix/erratas-cap8, propuesta/lenguaje-inclusivo).
  4. Editar los archivos siguiendo el formato de la guía.
  5. Enviar una solicitud de incorporación de cambios (pull request) con un resumen claro: qué cambia, por qué y qué fuentes lo respaldan.
  6. Participar en la revisión. Se espera una respuesta razonable a los comentarios.
  7. Incorporación. Quien mantiene la guía fusiona los cambios cuando hay consenso.

31.3. Criterios de aceptación​

  • Fundamento: el cambio se apoya en normas, fuentes o usos documentados.
  • Generalidad: sirve a proyectos diversos, o se presenta como opción o anexo.
  • Claridad: está bien redactado, con ejemplos.
  • Coherencia: no contradice otras secciones sin justificarlo.
  • Neutralidad: presenta las opciones con sus ventajas e inconvenientes, sin imponer posturas donde hay variación legítima.

31.4. Estilo de los ejemplos​

  • Se incluye el original, la versión incorrecta o evitable y la recomendada, con una explicación breve.
  • Se usan ejemplos realistas, sin referencias a proyectos concretos salvo que se mencionen como casos de estudio.
  • Los ejemplos con variación regional indican las regiones.

31.5. Cambios mayores​

Los cambios que afectan a normas ya consolidadas se discuten en un hilo abierto durante un plazo mínimo (se sugieren 14 días) y se resuelven según el capítulo 25.

31.6. Versionado y registro de cambios​

  • Se usa un esquema de versiones sencillo (MAYOR.MENOR.PARCHE).
  • Cada versión actualiza un archivo CHANGELOG.md.
  • Los cambios de criterio se anotan de forma visible.

31.7. Código de conducta y créditos​

Toda participación se rige por un código de conducta basado en el respeto y la colaboración. Las personas que contribuyen se mencionan en un archivo de créditos.

31.8. Licencia​

Todo el contenido del repositorio está dedicado al dominio público mediante CC0 1.0 Universal (véase el apartado 1.4 y el archivo LICENSE). Al contribuir, se acepta que el aporte se publique en las mismas condiciones. No envíe textos ajenos que no puedan dedicarse al dominio público.