Creación de un Proyecto PHP con Git y GitHub

Curso de Visual Studio Code para desarrolladores PHP

En esta sección, aprenderás a inicializar un proyecto PHP con Git y a vincularlo con un repositorio en GitHub para gestionar versiones y facilitar la colaboración.

1. Inicializar un Proyecto PHP con Git:
   • En Visual Studio Code, abre la carpeta de tu proyecto PHP.
   • Abre el terminal integrado y ejecuta el siguiente comando para iniciar Git en el proyecto:
     git init
   • Crea un archivo .gitignore para evitar que Git incluya archivos innecesarios como configuraciones locales o dependencias externas:
     echo "vendor/" > .gitignore
2. Crear un Repositorio en GitHub:
   • Ve a GitHub y crea un nuevo repositorio.
   • Copia la URL de tu repositorio y regresa a Visual Studio Code.
   • Vincula el proyecto local al repositorio de GitHub ejecutando:
     git remote add origin <URL-del-repositorio>
   • Sube los cambios iniciales:
     git add . git commit -m "Inicio del proyecto PHP" git push -u origin main

8.2 Documentación del Proyecto en un README.md

La documentación en un archivo README.md es fundamental para que otros comprendan cómo funciona tu proyecto.

Creación y Edición de README.md:

• Crea un archivo README.md en la raíz de tu proyecto.
• Escribe una descripción breve, instrucciones de instalación, y un ejemplo de uso básico del proyecto en Markdown. Un ejemplo simple podría ser:

# Mi Proyecto PHP

Este es un proyecto PHP para demostrar las habilidades aprendidas en Visual Studio Code.

## Instalación

Clona el repositorio:

Formateo con Markdown:

• Usa encabezados, listas y bloques de código para organizar el contenido. Esto hace que la documentación sea clara y fácil de leer.

8.3 Configuración y Ejecución de Pruebas en el Proyecto

Las pruebas unitarias ayudan a asegurar la calidad del código al verificar que cada parte funcione según lo esperado. En esta sección, configuraremos PHPUnit para ejecutar pruebas en el proyecto.

Instalación de PHPUnit:

• Si no tienes PHPUnit, instálalo ejecutando:
  composer require --dev phpunit/phpunit

Crear una Prueba Unitaria:

• Crea una carpeta llamada tests en tu proyecto.
• Dentro de tests, crea un archivo de prueba para una clase o función específica, por ejemplo, tests/CalculadoraTest.php:

<?php
use PHPUnit\Framework\TestCase;

class CalculadoraTest extends TestCase {
    public function testSuma() {
        $resultado = suma(2, 3);
        $this->assertEquals(5, $resultado);
    }
}

Ejecutar las Pruebas:

• Ejecuta las pruebas usando el terminal:
  ./vendor/bin/phpunit tests
• Visualiza los resultados de las pruebas en el terminal. Esto te permitirá verificar que todas las partes del código funcionan correctamente.

8.4 Revisión de Código y Mejora del Proyecto

Para finalizar el proyecto, aplicaremos buenas prácticas para mejorar la calidad del código, lo que incluye revisión y refactorización.

Revisión de Código:

• Lee cada archivo y busca inconsistencias en la lógica o errores.
• Aplica estándares de codificación para PHP, utilizando herramientas como PHP CS Fixer para formatear el código automáticamente:
  ./vendor/bin/php-cs-fixer fix src

Refactorización y Mejora:

• Identifica partes del código que puedan simplificarse o reutilizarse.
• Agrega comentarios donde sea necesario para explicar partes complejas.

Revisión Final y Documentación:

• Asegúrate de que el archivo README.md incluya las instrucciones actualizadas.
• Haz un commit final con todos los cambios realizados:
  

git add .
git commit -m "Refactorización final y actualización de documentación"
git push origin main