CopilotLab/PetroGlyphScout
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
PetroGlyphScout/MD/Contributing.md
KyMAN bd8aa68175 feat: Project done.
2025-08-20 17:14:43 +02:00

2.2 KiB
Raw Permalink Blame History

Contributing — PetroGlyphScout

Nota rápida: este proyecto es intencionalmente un OnePage/OneFile: la pieza canónica y la única que aceptamos como contribución es Public/index.html.

Contexto

  • Durante el desarrollo quedaron varios ficheros auxiliares y de soporte en el repositorio (JSON de datos ampliados, SVGs, documentos de trabajo). Para mantener el proyecto simple, las directrices de contribución se limitan al HTML que constituye la UI funcional.

Qué se acepta

  • Cambios en Public/index.html que mejoren la usabilidad, accesibilidad, búsqueda, rendimiento o corrección de bugs de la interfaz.
  • Pequeños assets directamente vinculados al HTML (por ejemplo, un SVG nuevo referenciado desde Public/index.html) siempre que no rompan la filosofía OnePage/OneFile.

Qué no se necesita (y no revisaré habitualmente)

  • Ediciones masivas a Public/json/* o a documentación de desarrollo: esos ficheros son artefactos que pueden existir para trabajo local, pero las PRs que sólo modifiquen datasets grandes o ficheros auxiliares pueden ser ignoradas.

Guía rápida para contribuir

  1. Haz fork y crea una rama, por ejemplo feature/mi-cambio.
  2. Haz cambios solo en Public/index.html (y archivos menores que el HTML referencia directamente si son imprescindibles).
  3. Mantén los commits pequeños y descriptivos.
  4. Prueba el HTML localmente abriéndolo con file:// o sirviéndolo por HTTP si lo prefieres.
  5. En el PR indica claramente el objetivo del cambio y, si procede, incluye una captura de pantalla o un GIF corto.

Recomendaciones técnicas

  • Mantén la compatibilidad con apertura mediante file:// (no asumir siempre fetch/HTTP en estado servidor).
  • Evita introducir dependencias externas pesadas; el objetivo es que Public/index.html sea autónomo.
  • Si por motivos prácticos necesitas actualizar un JSON pequeño (p. ej. corregir una keyword concreta), documenta la razón en el PR; las modificaciones grandes de datasets se deben discutir antes.

Proceso de revisión

  • Las PRs se evaluarán por claridad, tamaño razonable del cambio y que mantengan la filosofía OnePage/OneFile.

Gracias por contribuir. Si tienes dudas sobre si tu cambio encaja, abre un Issue antes de preparar la PR para discutirlo.