Saltar al contenido

Contribuir

Mejorar una skill existente

Si tu contribución es sobre el contenido de un sector — una fuente nueva, un enlace roto, una nota de navegación desactualizada — ubícala en la subcarpeta del atlas correspondiente dentro del monorepo. El flujo es el estándar de GitHub:

  1. Haz un fork del repositorio.
  2. Crea una rama descriptiva (git checkout -b corrige-enlace-ideam).
  3. Realiza tus cambios y confírmalos.
  4. Abre un Pull Request hacia main describiendo qué cambiaste y por qué.

Para correcciones menores —un enlace roto, una errata— basta con abrir un Issue que describa el problema.

Proponer una entidad nueva dentro de un atlas existente

Una entidad nueva se documenta con los tres archivos que exige el estándar (N1): SKILL.md, mapa-web.md y fuentes.md, dentro de una carpeta navegar-<entidad> del atlas correspondiente. Las plantillas de estandar/templates/ sirven de punto de partida, y las skills ya registradas son la referencia de buenas prácticas. El mismo flujo de fork y Pull Request aplica.

Registrar un atlas propio

Registrar un atlas nuevo — de otro sector o de otro país — exige tres pasos:

  1. Cumplir la parte normativa del estándar (N1–N5 y autocontención) y declarar la versión de la especificación que el atlas cumple. El script verificar-conformidad.sh del repositorio lo comprueba con un comando; el mismo chequeo corre en cada Pull Request.
  2. Abrir un Pull Request a registro.md que agregue:
    • la fila del atlas en la tabla de atlas registrados,
    • su tabla de entidades.
  3. El mismo Pull Request agrega la tarjeta del atlas al banner del README.md (logo en atlas/<sector>/assets/ si el atlas vive como subcarpeta del monorepo, o en el assets/ de su propio repositorio si es externo) y su fila en la tabla «Atlas registrados» del README.
  4. El mismo Pull Request agrega a examples/consultas-de-ejemplo.md al menos una consulta que cruce hacia un atlas ya registrado, con su ruta esperada. Es la demostración de que el atlas se integró: una consulta se puede correr, una declaración no.

El registro se acepta cuando el atlas ya está publicado y cumple la parte normativa de la versión del estándar que declara.

Otros tipos de contribución

  • Cambios al estándar: estandar/especificacion.md es el único documento versionado de Public Orbit. Requieren abrir primero un Issue indicando qué componente de versión subiría (parche, menor o mayor), y solo después el Pull Request.
  • Orquestadora nacional: los cambios a atlas-orquestador-colombia se proponen directamente por Pull Request, respetando el patrón de enrutamiento (N4). El enrutamiento se expresa como criterio y ejemplos, no como catálogo de temas.
  • Consultas de ejemplo: examples/consultas-de-ejemplo.md reúne consultas que cruzan atlas, cada una con su ruta esperada, sin URLs.

Guía completa: github.com/Nicolas9714/public-orbit/blob/main/CONTRIBUTING.md · Issues: github.com/Nicolas9714/public-orbit/issues