Todas las noticias
Técnica

GitHub integra el archivo ACCESSIBILITY.md en los repositorios

Por JP Software ·

JP Software
Ilustración de la nota: GitHub integra el archivo ACCESSIBILITY.md en los repositorios
JP Software

GitHub anunció la integración oficial del archivo ACCESSIBILITY.md dentro de la vista general de los repositorios. Con este cambio, la plataforma busca que los mantenedores y desarrolladores cuenten con un espacio estándar para documentar metas de accesibilidad, limitaciones conocidas, entornos compatibles y procesos claros para reportar fallas.

Datos clave

  • GitHub reconoce el archivo si se ubica en la raíz del proyecto, en el directorio .github/ o en la carpeta docs/, según GitHub.
  • Los repositorios pueden heredar este archivo a nivel organizacional desde el repositorio .github/ central, según GitHub.
  • Los nuevos repositorios creados en la plataforma incluyen una etiqueta de problema de accesibilidad de forma predeterminada, según GitHub.
  • Los proyectos públicos pueden crear o proponer el archivo desde la ruta Insights > Community Standards utilizando una plantilla inicial, según GitHub.

Ubicación y estructura del archivo ACCESSIBILITY.md

El archivo se suma a otros documentos de salud comunitaria ya existentes en la plataforma, como las pautas de contribución, los códigos de conducta y las políticas de seguridad. Al situarse en la raíz, en .github/ o en docs/, la información queda visible directamente en la página principal del proyecto.

GitHub explicó que no existe un formato único obligatorio para este documento, ya que una herramienta de línea de comandos, una librería pequeña o una aplicación web completa tienen necesidades y capacidades de mantenimiento distintas. Sin embargo, se recomienda que el texto cubra aspectos fundamentales:

  • Prioridades y objetivos: Explicar qué experiencias de usuario reciben atención y el alcance del proyecto.
  • Expectativas para colaboradores: Describir qué revisiones o pruebas de accesibilidad se solicitan al enviar cambios, incluyendo instrucciones para personas y agentes de código.
  • Reporte de barreras: Ofrecer un canal directo que no obligue a revelar discapacidades ni a compartir capturas de pantalla o grabaciones.
  • Entornos compatibles y limitaciones: Detallar plataformas, navegadores, lectores de pantalla validados, fallas identificadas y alternativas de uso temporales.

Casos prácticos documentados

Como ejemplo del uso de este estándar, GitHub CLI documenta barreras concretas en su declaración, como la dificultad de procesar tablas con lectores de pantalla, y ofrece comandos alternativos para listar datos línea por línea. También solicita a los colaboradores probar la salida en terminal con ajustes de accesibilidad activos antes de proponer cambios.

De igual forma, el proyecto GitHub Annotation Toolkit utiliza este archivo para transparentar que su librería de Figma no ha sido evaluada con navegación exclusiva por teclado o lectores de pantalla, pidiendo descripciones estructuradas en texto para acompañar las anotaciones de diseño.

Por qué te importa

Centralizar la accesibilidad en un archivo visible evita que el contexto técnico se pierda en comentarios de issues o revisiones de código pasadas. Si mantienes librerías o aplicaciones de código abierto, contar con ACCESSIBILITY.md define reglas claras para quienes colaboran en el repositorio y le ahorra fricción a los usuarios que necesitan herramientas de asistencia técnica.

Comparte esta nota