A development workspace with notes for an open-source contribution, editorial illustration
LA GUÍA

Modificar proyectos de código abierto

Una guía para principiantes sobre cómo contribuir a proyectos de código abierto.

Empezar a leer
9 min de lectura16 imágenesEspañolPágina original
MODO DE LECTURA

Este tutorial ilustrado incluye programas y equipos antiguos. Sus capturas explican el proceso, pero los menús, precios, requisitos y disponibilidad pueden diferir. Consulta la documentación enlazada del proyecto para la versión que utilizas.

Ilustración de la modificación de proyectos de código abierto

Cómo crear una bifurcación de un proyecto de código abierto

Entrar en el software de código abierto puede intimidar si estás empezando, pero te acompañaremos. Desglosaremos cada parte del proceso utilizando Bitcoiner.Guide para practicar: escribirás un artículo y propondrás cambios para incorporarlos al proyecto principal.

Paso 1: crear una cuenta de GitHub e instalar las herramientas necesarias

Pasos necesarios

Comprueba que tienes todas las herramientas necesarias instaladas en el ordenador.

  1. Una cuenta de GitHub: necesitas una cuenta en GitHub para bifurcar el proyecto y presentar cambios. Si no tienes una, créala en GitHub.

  2. Git: Git es un sistema de control de versiones para seguir y gestionar cambios en el código. Es esencial para trabajar con GitHub y viene instalado en muchos equipos. Abre la terminal e introduce git -v: si está instalado, verás su versión. Si no, consulta esta guía.

  3. Visual Studio Code: un editor versátil con funciones que facilitan el trabajo con Git. Descárgalo aquí.

  4. Para el código histórico de Jekyll, instala un entorno Ruby compatible y Bundler antes de las dependencias del repositorio. En macOS, utiliza un Ruby separado gestionado por chruby, rbenv, asdf u otro gestor compatible; no dependas del Ruby del sistema de Apple. Comprueba ruby -v e instala las gemas necesarias en ese entorno sin recurrir habitualmente a sudo. En Windows necesitas un RubyInstaller compatible y herramientas de desarrollo. Estos pasos de Jekyll describen el repositorio original, no el rediseño estático 3.0.

Información adicional

La forma de abrir una terminal depende del sistema operativo. Así se hace en los tres sistemas de escritorio más habituales:

  1. Windows:
    • Desde Inicio: haz clic en Inicio o pulsa Windows, escribe «cmd» o «Símbolo del sistema» en la búsqueda y pulsa Intro.
    • Desde Ejecutar: pulsa Windows+R, escribe «cmd» y pulsa Intro.
  2. macOS:
    • Desde Spotlight: pulsa Command+Space, escribe «Terminal» y pulsa Intro.
    • Desde Finder: abre Finder, ve a Aplicaciones -> Utilidades y haz doble clic en Terminal.
  3. Linux:
    • Desde la lista de aplicaciones: según la distribución y el entorno, encontrarás Terminal en la lista de aplicaciones o el lanzador.
    • Con un atajo de teclado: en muchas distribuciones, Ctrl+Alt+T abre una ventana de terminal.

En Visual Studio Code, cualquiera que sea el sistema, puedes abrir la terminal desde View -> Terminal en el menú superior.

Paso 2: bifurcar Bitcoiner.Guide

Una bifurcación crea una copia del repositorio en tu cuenta de GitHub para que puedas modificarlo sin afectar al proyecto original.

  1. Ve a https://github.com/BitcoinQnA/Bitcoiner.Guide.
  2. Pulsa «Fork» arriba a la derecha para crear una copia en tu cuenta.

FIG. 01Paso 2: bifurcar Bitcoiner.GuideIlustración de la modificación de proyectos de código abierto

Paso 3: clonar el proyecto en tu ordenador

Ahora necesitamos una copia del proyecto en tu ordenador: vamos a «clonarlo».

  1. Abre tu bifurcación. La URL debería ser https://github.com/YOUR_GITHUB_USERNAME/Bitcoiner.Guide
  2. Pulsa el botón verde «Code» y el icono del portapapeles para copiar la URL.

FIG. 02Paso 3: clonar el proyecto en tu ordenadorIlustración de la modificación de proyectos de código abierto

  1. Abre Visual Studio Code.
  2. Pulsa «Source Control» en el panel izquierdo.
  3. Pulsa «Clone Repository».
  4. Pega la URL copiada en el cuadro de diálogo y pulsa Intro.

FIG. 03Paso 3: clonar el proyecto en tu ordenadorIlustración de la modificación de proyectos de código abierto

  1. Cuando se te pida una carpeta, ve al escritorio y pulsa «Select Repository Location».

FIG. 04Paso 3: clonar el proyecto en tu ordenadorIlustración de la modificación de proyectos de código abierto

Paso 4: crear una rama nueva

Crear una rama para tus cambios es una buena práctica en proyectos colaborativos, incluido el código abierto. Permite aislar tus cambios del proyecto principal, cuya rama suele llamarse «main» o «master».

  1. Pulsa el nombre de la rama abajo a la izquierda; debería ser master o main.
  2. En el cuadro de diálogo, selecciona Create new branch.
  3. Pon nombre a la rama, por ejemplo «foundation-devices», y pulsa Intro.

FIG. 05Paso 4: crear una rama nuevaIlustración de la modificación de proyectos de código abierto

Puedes volver a la rama principal en cualquier momento pulsando el nombre abajo a la izquierda y eligiéndola en la lista.

Paso 5: preparar el proyecto localmente

Lee el README actual, el archivo de versiones fijadas de dependencias y las instrucciones de contribución antes de instalar Ruby o Bundler. Trabaja en una rama de función, ejecuta las comprobaciones locales documentadas y presenta una solicitud de incorporación. Los comandos siguientes describen el proyecto Jekyll original; no son instrucciones de compilación de este experimento de diseño local.

Vamos a ejecutar Bitcoiner.Guide en tu ordenador.

  1. Abre la terminal de Visual Studio Code mediante View -> Terminal.

FIG. 06Paso 5: preparar el proyecto localmenteIlustración de la modificación de proyectos de código abierto

  1. Ejecuta bundle install para instalar las gemas Ruby necesarias.
  2. Ejecuta bundle exec jekyll serve para iniciar un servidor local.
  3. Ya puedes ver el sitio en http://localhost:4000.

FIG. 07Paso 5: preparar el proyecto localmenteIlustración de la modificación de proyectos de código abierto

Después de clonar este repositorio histórico de Jekyll, ejecuta bundle install desde la carpeta que contiene Gemfile y después bundle exec jekyll serve. Instalar Bundler no instala las dependencias del repositorio. Repite bundle install cuando cambien sus archivos de dependencias.

Paso 6: hacer cambios y registrarlos

Vamos a modificar el proyecto añadiendo un artículo llamado «Foundation Devices»:

  1. En Visual Studio Code, crea un archivo con el formato foundation-devices.md.

FIG. 08Paso 6: hacer cambios y registrarlosIlustración de la modificación de proyectos de código abierto

  1. Añade estos metadatos al principio del archivo:
---
layout: page
title: Foundation Devices
subtitle: Sovereign computing company
---
  1. Escribe el artículo debajo de los metadatos. Por ejemplo:

Foundation Devices fabrica herramientas de hardware centradas en Bitcoin que te ayudan a recuperar tu soberanía digital. Su objetivo era crear una empresa de hardware distinta, centrada en el código abierto y la fabricación local. Empieza con Passport y Envoy, ¡pero esto es solo el principio!

Los artículos de Bitcoiner.Guide utilizan formato Markdown, un lenguaje de marcado ligero para dar formato al texto. Esta excelente guía enseña a poner negritas, crear listas y más.

Para incluir imágenes:

  1. Primero sube la imagen a la carpeta assets > img del proyecto.

FIG. 09Paso 6: hacer cambios y registrarlosIlustración de la modificación de proyectos de código abierto

  1. Después utiliza esta sintaxis:
<p align="center">
  <img src="/assets/img/your-image-file-name.jpg" class="responsive" style="max-width: 100%; height: auto;" />
</p>
  1. Sustituye your-image-file-name.jpg por el nombre del archivo de imagen.
  2. Guarda con CMD+S o CTRL+S.
  3. Vuelve al navegador y abre http://localhost:4000/foundation-devices

Hemos transformado esto:

---
layout: page
title: Foundation Devices
subtitle: Sovereign computing company
---
Foundation Devices is a hardware company that builds Bitcoin-centric tools that empower you to reclaim your digital sovereignty. They aimed to build a different kind of hardware company with an emphasis on Open Source and local manufacturing. This starts with Passport and Envoy – but they are just getting started!

<p align="center">
  <img src="/assets/img/foundation-devices-images.jpg" class="responsive" style="max-width: 100%; height: auto;" />
</p>

En esto:

FIG. 10Paso 6: hacer cambios y registrarlosIlustración de la modificación de proyectos de código abierto

Consulta otros artículos .md del proyecto para comprender cómo se construyen. Respeta el estilo de escritura para mantener la coherencia.

Paso 7: subir tus cambios a GitHub

Guardemos los cambios y subámoslos a GitHub.

  1. Pulsa el icono de control de versiones a la izquierda de Visual Studio Code.
  2. Verás tus cambios en «Changes». Pulsa el «+» junto a los archivos para prepararlos para el commit.

FIG. 11Paso 7: subir tus cambios a GitHubIlustración de la modificación de proyectos de código abierto

  1. Escribe un mensaje de commit en el cuadro superior, como «Añadir artículo sobre Foundation Devices», y pulsa Ctrl+Enter o Cmd+Enter en Mac.
  2. Pulsa los tres puntos de la vista Source Control y elige «Push» para subir los cambios a GitHub.

FIG. 12Paso 7: subir tus cambios a GitHubIlustración de la modificación de proyectos de código abierto

FIG. 13Paso 7: subir tus cambios a GitHubIlustración de la modificación de proyectos de código abierto

Paso 8: abrir una solicitud de incorporación

Por último, propongamos incorporar tus cambios al proyecto original:

  1. Ve a https://github.com/YOUR_GITHUB_USERNAME/Bitcoiner.Guide
  2. Pulsa «Pull request».
  3. Pulsa «New pull request» o «Compare & pull request».

FIG. 14Paso 8: abrir una solicitud de incorporaciónIlustración de la modificación de proyectos de código abierto

  1. Comprueba que «base repository» sea BitcoinQnA/Bitcoiner.Guide y «head repository» sea YOUR_GITHUB_USERNAME/Bitcoiner.Guide.
  2. Pulsa «Create pull request».
  3. Introduce un título y una descripción de los cambios.
  4. Vuelve a pulsar «Create pull request».

FIG. 15Paso 8: abrir una solicitud de incorporaciónIlustración de la modificación de proyectos de código abierto

¡Enhorabuena! Has bifurcado Bitcoiner.Guide, contribuido y abierto una solicitud de incorporación. El responsable, en este caso QnA, revisará los cambios. Puede aceptarlos, pedir modificaciones o comentarlos contigo.

Pasos opcionales

Paso 9: hacer cambios adicionales después de crear la solicitud

Después de crear la solicitud, quizá quieras modificar algo más o los responsables te pidan revisiones. Puedes hacerlo sin abrir otra solicitud. Así:

  1. Comprueba que estás en la rama correcta en Visual Studio Code, la misma utilizada para los cambios iniciales y la solicitud.
  2. Haz los cambios adicionales y guarda los archivos.
  3. Prepara y registra los cambios como en el paso 6-7.
  4. Pulsa los tres puntos de Source Control y selecciona «Push».

Los cambios actualizarán automáticamente la solicitud existente en GitHub. No hace falta otra. Si quieres comentarlos, abre tu solicitud en GitHub y añade un comentario a la conversación.

Paso 10: mantener actualizada tu bifurcación

Descargar actualizaciones solo obtiene el estado del repositorio disponible en ese momento. Revisa y aplica las siguientes actualizaciones de forma deliberada; una descarga correcta no garantiza que el despliegue siga actualizado automáticamente.

Al bifurcar un proyecto, creas una instantánea de un momento concreto. El original sigue evolucionando con los cambios de otros colaboradores. Para mantener actualizada tu copia, sigue estos pasos:

  1. Añadir el proyecto original como repositorio remoto: este paso indica a Git dónde está el proyecto original. Solo necesitas hacerlo una vez.
    • Abre Visual Studio Code y comprueba que tienes abierto el proyecto Bitcoiner.Guide.
    • Abre la terminal de Visual Studio Code mediante View -> Terminal.
    • Introduce git remote add upstream https://github.com/BitcoinQnA/Bitcoiner.Guide.git y pulsa Intro. El comando añade el proyecto original como repositorio remoto con el nombre «upstream».
  2. Obtener los cambios del proyecto original: este paso descarga los cambios más recientes del original, pero todavía no los integra en tu proyecto.
    • Introduce git fetch upstream en la terminal y pulsa Intro.
  3. Cambiar a la rama principal: integra los cambios en la rama principal, no en la rama de función donde hiciste tus modificaciones.
    • Pulsa el nombre de la rama abajo a la izquierda de Visual Studio Code; debería ser tu rama de función.
    • En el cuadro de diálogo, elige la rama principal, normalmente main o master.
  4. Integrar los cambios: este paso incorpora los cambios del proyecto original a tu rama principal.
    • Introduce git merge upstream/main o git merge upstream/master en la terminal, según el nombre de la rama principal del original, y pulsa Intro.

Conclusión

Contribuir a proyectos de código abierto como Bitcoiner.Guide puede intimidar, especialmente al principio. Esta guía completa ofrece los pasos y las herramientas necesarios para bifurcar un proyecto, modificarlo y presentar una solicitud de incorporación con confianza.

Contribuir al código abierto incluye colaborar, aprender, compartir y mejorar, además de programar. No te desanimes si algo no sale perfecto al principio. La práctica te hará sentir más cómodo. Todas las contribuciones son valiosas, por pequeñas que sean.

Sobre el autor

¡Hola, soy Bitlevi! Escribo sobre Bitcoin y herramientas FOSS para plasmar lo que aprendo en mi camino hacia la soberanía. Puedes escribirme en Twitter o visitar mi sitio web. Si te ha gustado la guía y quieres donar, ¡aquí está mi PayNym!


Continúa tu recorrido

Una pregunta lleva a otra.

01Una transacción atascada: esperar, acelerarla o cancelarla02Cómo gestionar tus monedas y comisiones

Find your next answer.

Search the complete field guide · Esc to close