Cómo usar este repositorio
Cómo usar este repositorio
En este repositorio iremos recogiendo todos los contenidos que generéis durante las reuniones de expertos, en las que trabajaréis contenidos adicionales sobre la asignatura que no presentaremos durante las clases expositivas.
Para incorporar estas aportaciones, utilizaremos el flujo de trabajo que ya has visto en los tutoriales que has realizado: fork a tu cuenta personal, branch con las modificaciones concretas en las que estés trabajando, y pull request para incorporar tus cambios al repositorio central.
La primera vez que lo uses
Vamos a aprovechar la configuración del entorno de trabajo con este repositorio para recordar la manera concreta de aplicar este flujo de trabajo y al mismo tiempo dejar ya preparado el repositorio para cuando empecemos con el trabajo de verdad.
- Clona este repositorio a tu ordenador. En la terminal, accede a la carpeta en la que almacenes tus repositorios git, y utiliza el comando
git clone https://github.com/DeustoPWEB2018/Elementos-de-la-UX.git
. Esto creará la carpetaElementos-de-la-UX
en tu ordenador.
Con esto ya tendrás una copia personal del repositorio de contenidos adicionales en tu ordenador, que utilizarás a lo largo de todo el semestre. La manera de trabajar será prácticamente idéntica para las modificaciones futuras en este repositorio, tal y como se detalla en el siguiente apartado.
Aportaciones del trabajo con expertos
Cuando os reunáis con el grupo de expertos, primero decidid quién se encargará de cada tarea:
-
Secretaría: tomar nota y recoger el acta en papel de la reunión durante la clase, decisiones, primera redacción del contenido
contribuir al contenido después de clase, revisar y comentar el contenido antes de entregar
-
Control: controlar el tiempo y asegurar el cumplimiento de los requisitos
añadir el texto al repositorio (instrucciones a continuación), contribuir al contenido después de clase, revisar y comentar el contenido antes de entregar
-
Comunicación: comunicarse con el profesor y/o otros grupos, presentar el contenido a la clase
marcar el contenido como finalizado (instrucciones a continuaión), contribuir al contenido después de clase, revisar y comentar el contenido antes de entregar
A continuación se detallan las tareas paso a paso para cada rol.
Control
La persona encargada de control será quien incorpore el contenido redactado o iniciado durante la clase (recogido en el acta en papel por secretaría) en este repositorio. Para esto:
- Asegúrate de que tienes la última versión del repositorio en tu ordenador. En tu terminal:
git pull origin master
- Cámbiate al branch de trabajo para vuestro tema
- Si ya habías creado el branch, cámbiate con
git checkout TEMA
y asegúrate de tenerlo actualizado congit pull origin TEMA
- Si no lo has creado aún, hazlo nombrando el branch con una palabra que indique el tema en el que estáis trabajando:
git checkout -b TEMA
.
- Si ya habías creado el branch, cámbiate con
- Utilizando Sublime Text, crea un archivo nuevo y añade el texto que hayáis elaborado durante la reunión en clase utilizando la sintaxis de Markdown. Aseguráos de establecer quién escribirá sobre cada sección o parte del documento, para evitar pisaros durante el trabajo
- Guárdalo en la carpeta de la unidad correspondiente, con el nombre del tema que estéis tratando y añadiendo la extensión
.md
al final, por ejemplo,personas.md
. Ten en cuenta estas indicaciones a la hora de dar nombre a los archivos:- Utiliza siempre minúsculas
- Evita utilizar espacios: puedes sustituirlos por guiones
- No utilizar caracteres especiales como ñ, letras con tilde, o símbolos como \& o \%
- Vuelve a la terminal y comprueba que git ha detectado los cambios con
git status
. Asegúrate de que estás en tu branch de trabajo,TEMA
- Añade los cambios y haz commit con un mensaje descriptivo:
git add . git commit -m "Generar el documento sobre Personas"
- Envía los cambios al repositorio central en la nube:
git push origin TEMA
- Accede con tu navegador al repositorio y, si aparece tu recién creado branch, simplemente haz clic en Compare & pull request. Si no, haz clic en la pestaña Pull requests, y ahí en el botón New pull request
-
Base debe ser el branch
master
-
Compare debe ser tu branch,
TEMA
- Haz clic en Create pull request
-
Base debe ser el branch
- En el lado derecho de la página del pull request,
- haz clic en Reviewers y señala a todas las personas que hayan participado en tu grupo de expertos
- haz clic en Milestone y selecciona la unidad a la que corresponde este tema
Recuerda revisar también las instrucciones para contribuir al contenido.
Comunicación
Una vez que el trabajo esté terminado y tenga todos los miembros del grupo hayan aprobado el contenido, la persona encargada de comunicación marcará el pull request con la etiqueta correspondiente. Para esto:
- Accede a la página del pull request y, en el lado derecho, haz clic en Labels y selecciona terminado
- En Assignee, añade a @mberasategi
Es importante que recordéis que el plazo para esto es antes de la clase del segundo lunes de cada unidad.
Recuerda revisar también las instrucciones para contribuir al contenido.
Todos los miembros del grupo de expertos
Autoevaluaciones
En cuanto finalicemos la clase dedicada al trabajo en grupos de expertos, todos tendréis que realizar las autoevaluaciones para todos los participantes. Las autoevaluaciones se recogen en una carpeta llamada evaluaciones
dentro del directorio correspondiente a cada unidad.
Cada vez que participes en una sesión de trabajo en grupos de expertos:
- En la terminal, accede a tu carpeta del repositorio y crea el branch de trabajo para utilizar durante esta unidad:
git checkout -b TEMA
- Abre la carpeta en tu Explorador de archivos (Windows) o Finder (Mac). Accede al directorio
evaluaciones
de la unidad en la que estemos trabajando. Haz una coia del archivo Excel que tienes en esa carpeta (MiApellidoMiNombre-2018MMDD.xlsx
) y cámbiale el nombre para que indique tu nombre y la fecha correcta, por ejemplo,BerasategiMiren-20181002.xlsx
- Abre el archivo recién creado y rellena en esa hoja de cálculo tus evaluaciones (para ti y el resto de miembros que han trabajado contigo en el grupo de expertos), siguiendo las indicaciones que encontrarás en el mismo documento, y guárdalo
- En la terminal, guarda, confirma y envía a la nube los cambios realizados:
git add . git commit -m "Evaluar reunión del día 20181002" git push origin TEMA
Contribución de contenido
Como probablemente no tendremos tiempo durante la clase dedicada al trabajo en grupos de expertos de finalizar la redacción, será necesario que cada uno de los miembros del grupo continúe aportando al documento conjunto durante el resto de la semana. Para esto, cada vez que vayas a iniciar el trabajo en tu ordenador:
- Asegúrate de que tu copia local está actualizada con los últimos cambios del repositorio central:
git pull origin TEMA
- Cámbiate al branch de trabajo para vuestro tema:
git checkout TEMA
- Utilizando Sublime Text, realiza tus contribuciones a la sección que te corresponda de vuestro tema
- En la terminal, guarda, confirma y envía a la nube los cambios realizados utilizando un mensaje descriptivo de los cambios que has estado haciendo:
git add . git commit -m "Un mensaje descriptivo de lo que has estado haciendo" git push origin TEMA
Recuerda guardar y confirmar los cambios cada vez que finalices un bloque de modificaciones (con git add .
y git commit -m "Mensaje descriptivo"
). Puedes subir a la nube (git push origin TEMA
) solo de vez en cuando, por lo menos cuando vayas a dejar de trabajar temporalmente. Cuando vuelvas al trabajo, sigue los pasos empezando otra vez desde el 1.
Revisar y aprobar el contenido
Además de contribuir al contenido, todos los miembros del grupo de expertos tenéis también que revisar y comentar el contenido de los demás. Podréis ver las contribuciones de las otras personas en el documento de trabajo, y utilizad la página del pull request para comentar y discutir sobre el contenido.
Puedes añadir tu revisión haciendo clic en el botón Add your review que aparecerá en la parte superior de la página del pull request. Tienes varias opciones:
- Simplemente añadir un comentario. Escríbelo, selecciona Comment y haz clic en Submit review
- Aprobar las contribuciones. Puedes escribir un comentario si quieres. Selecciona Approve y haz clic en Submit review
- Solicitar algunos cambios. Escribe qué cambios crees que son necesarios y, a ser posible, menciona con @ a la persona encargada de realizarlos. Selecciona Request changes y haz clic en Submit review