DELPHIHEAVEN · GUÍA TÉCNICA
Publicar y documentar un proyecto Delphi en GitHub
Se conserva el historial de cambios y se presenta el proyecto de forma útil para otros desarrolladores.
Los ejemplos se utilizan como orientación didáctica y se verifican en el IDE y en los dispositivos adecuados antes de incorporarlos a una aplicación.
Preparar el repositorio
Se separa el código fuente de los artefactos generados: ejecutables, carpetas temporales, cachés, contraseñas, bases de datos con datos reales y archivos de usuario. Se revisa el contenido antes de la primera publicación.
Comandos iniciales
git init -b main
git add .
git commit -m "Version inicial documentada"
git remote add origin https://github.com/USUARIO/REPOSITORIO.git
git push -u origin mainEstructura del README
- Se explica qué hace el proyecto y cuál es su estado real.
- Se indican tecnologías, dependencias y pasos de compilación.
- Se presentan capturas auténticas y una licencia si corresponde.
- Se diferencian las funcionalidades presentes de las ideas del roadmap.
- Se enlazan las guías técnicas desde la ficha en DelphiHeaven.
Mantenimiento
Se registran commits por cambios coherentes y se comprueba la compilación después de incorporar funciones. En un proyecto público se evita conservar secretos en la historia de Git. El README de PC Shop es una referencia de documentación de funcionalidades, arquitectura y evolución.
Referencias (APA 7)
GitHub. (s. f.). About the repository README file. GitHub Docs.
101aero. (s. f.). PC Shop [Código fuente]. GitHub.