Utilizar Visual Studio Code (VSCode) y GitHub para mostrar tus proyectos y código es una excelente opción. Aquí te presentamos los pasos que debes seguir para crear un repositorio de GitHub bien organizado, lo que incluye asegurarte de que no se filtren datos privados y crear un archivo README detallado:
- Crea una nueva carpeta en tu máquina local para el proyecto: Asegúrate de que la carpeta tenga un nombre significativo y se encuentre en un directorio donde normalmente almacenas tus proyectos de programación.
- Organiza tus archivos de código: Crea subcarpetas dentro de la carpeta principal de tu proyecto para almacenar tus diferentes archivos de código basados en su lenguaje o propósito. Por ejemplo, puedes crear carpetas separadas para tu código de Apps Script, JavaScript o Python.
- Limpia y comenta tu código: Revisa tu código para asegurarte de que no haya información sensible o privada incluida. Luego, agrega comentarios a lo largo del código para explicar qué hace cada parte. Esto facilitará que otros entiendan y aprendan de tu código.
- Inicializa un repositorio de Git: Abre la carpeta del proyecto en VSCode. Si aún no lo has hecho, instala la extensión de Git en VSCode. Luego, abre la terminal (View > Terminal) y ejecuta git init. Esto inicializará un nuevo repositorio de Git en tu carpeta de proyecto.
- Crea un archivo .gitignore: Para evitar que Git comprometa archivos sensibles o innecesarios en tu repositorio, crea un archivo .gitignore en el directorio raíz de tu proyecto. Agrega cualquier extensión de archivo o archivo específico que deba ser ignorado por Git. Por ejemplo, si estás utilizando un archivo .env para almacenar información confidencial, agrega .env a tu archivo .gitignore.
- Crea un archivo README.md: Crea un archivo README.md en el directorio raíz de tu proyecto. Utiliza este archivo para proporcionar una introducción a tu proyecto, explicar su propósito y dar instrucciones sobre cómo utilizar o ejecutar el código. Puedes utilizar la sintaxis Markdown para dar formato a tu texto y agregar fragmentos de código, imágenes u otros medios para hacer que el README sea más atractivo.
- Compromete tu código: Etapa y compromete tus archivos de código, junto con los archivos .gitignore y README.md, utilizando el panel de control de control de fuente en VSCode o ejecutando los siguientes comandos en la terminal:
git add .
git commit -m "Commit inicial"
- Crea un nuevo repositorio de GitHub: Ve a tu cuenta de GitHub y crea un nuevo repositorio. Puedes elegir hacerlo público o privado, según tus preferencias.
- Sube tu código a GitHub: En la terminal, agrega el repositorio de GitHub remoto usando el comando:
git remote add origin <tu-url-de-repo>
Reemplaza <tu-url-de-repo>
con la URL de tu repositorio de GitHub recién creado