Guía para Colaboradores: Trabajo en el Protocolo de Revisión de Alcance

Flujo de trabajo con Git, RStudio y Quarto para propuestas de modificación

Author

Giovanni Francisco Guevara Vásquez

Published

November 7, 2026

NoteObjetivo

Esta guía proporciona el paso a paso estructurado para clonar el repositorio del proyecto ScopingReview_GarbageCodes, realizar sugerencias de cambio sobre el documento principal ( / ) y enviar las modificaciones mediante un Pull Request.

1 Paso 1: Clonar el repositorio localmente

  1. Abre la terminal (o Git Bash en Windows).
  2. Clona el repositorio oficial ejecutando:
git clone [ScopingReview_GarbageCodes](https://github.com/gfguevara/ScopingReview_GarbageCodes)
  1. Accede al directorio del proyecto:
cd ScopingReview_GarbageCodes

2 Paso 2: Crear una rama (Branch) para tus cambios

Para mantener organizada la versión principal y evitar conflictos, no trabajes directamente sobre la rama main.

  1. Asegúrate de estar en la rama principal y tener la versión más reciente:
git checkout main
git pull origin main
  1. Crea y cambia a una nueva rama de trabajo (utiliza un nombre descriptivo, como propuesta-tuNombre):
git checkout -b propuesta-protocolo-tuNombre

3 Paso 3: Editar el documento en RStudio

  1. Abre el proyecto en RStudio haciendo doble clic sobre el archivo Protocol.Rproj.
  2. Abre el archivo principal del protocolo: Protocolo_ScopingReview_GarbageCodes.Rmd.
  3. Realiza tus modificaciones, correcciones o adiciones metodológicas.
  4. (Opcional pero recomendado) Haz clic en Render (o Knit / ) para verificar que el documento compile a HTML, Word o PDF sin errores.

4 Paso 4: Guardar y subir los cambios a GitHub

  1. Revisa los archivos modificados y prepáralos para el commit:
git add Protocolo_ScopingReview_GarbageCodes.Rmd
  1. Crea un commit con un mensaje claro sobre las modificaciones realizadas:
git commit -m "Propuesta: revisión de criterios de inclusión y estrategia de búsqueda"
  1. Sube la rama con tus cambios al repositorio remoto:
git push origin propuesta-protocolo-tuNombre

5 Paso 5: Crear un Pull Request (PR)

  1. Ve a la página principal del repositorio en GitHub: ScopingReview_GarbageCodes
  2. En la parte superior verás un banner destacado que dice “Compare & pull request”. Haz clic en él.
  3. Añade un título descriptivo a tu propuesta y detalla en la descripción los aspectos clave que modificaste o agregaste.
  4. Haz clic en “Create pull request”.
TipSiguiente paso

El investigador principal revisará los cambios, realizará comentarios sobre las líneas modificadas e integrará la propuesta a la rama principal ().

6 Opción recomendada: Trabajo desde RStudio usando Ramas y Pull Requests

Para trabajar visualmente desde RStudio sin sobrescribir la rama principal (main) y permitir que el dueño del proyecto revise los cambios antes de integrarlos, sigue este flujo:

6.1 1. Configuración inicial (solo la primera vez por propuesta)

  1. En la esquina superior derecha de RStudio, busca la pestaña Git.
  2. En la parte superior de esa pestaña, haz clic en el botón de New Branch (dos rectángulos conectados por una línea).
  3. Escribe un nombre descriptivo para tu rama (ejemplo: propuesta-seccion-metodos o cambios-tuNombre).
  4. Haz clic en Create. RStudio creará la rama y te cambiará automáticamente a ella.

6.2 2. Flujo de trabajo y envío de propuestas

  1. Editar el archivo:
    • Abre Protocolo_ScopingReview_GarbageCodes.Rmd.
    • Realiza tus modificaciones y guarda el documento (Ctrl + S).
  2. Hacer Commit:
    • En la pestaña Git, marca la casilla Staged al lado de Protocolo_ScopingReview_GarbageCodes.Rmd.
    • Haz clic en Commit.
    • Escribe un mensaje claro detallando tus sugerencias en Commit message.
    • Haz clic en el botón Commit.
  3. Hacer Push:
    • Haz clic en el botón Push (flecha verde hacia arriba). RStudio subirá tu rama con tus cambios a GitHub.
  4. Crear el Pull Request en GitHub:
    • Entra al repositorio en GitHub: ScopingReview_GarbageCodes
    • Haz clic en el botón amarillo Compare & pull request que aparecerá en la parte superior.
    • Explica brevemente tus modificaciones y haz clic en Create pull request.
Note¿Qué sucede después?

El dueño del proyecto recibirá una notificación en GitHub, podrá revisar exactamente qué líneas agregaste o eliminaste, dejar comentarios o sugerir correcciones, y finalmente hacer clic en Merge pull request para incorporar tus cambios a la rama principal.