Salta el contingut
 

Exercici: Col·laboració mitjançant Pull Requests

Joan Puigcerver Ibáñez

j.puigcerveribanez@edu.gva.es

Llicència: CC BY-NC-SA 4.0

(Reconeixement - NoComercial - CompartirIgual) 🅭

Objectius

Els objectius d'aquest exercici són:

  • Conéixer com crear una bifurcació o fork d'un projecte.
  • Conéixer com crear una Pull Request.
  • Conéixer com col·laborar en un projecte mitjançant Pull Requests.

Lliurament

Per a lliurar aquest exercici sols heu d'indicar la URL de la Pull Request que heu creat en la bústia de l'exercici.

Enunciat

El repositori Filmoteca conté diversos directoris amb informació sobre llibres, sèries i pel·lícules.

La tasca d'aquest bloc consisteix en fer una aportació a aquest repositori. Per fer-ho, seguiu els següents passos:

  1. Fes una bifurcació o fork del repositori Filmoteca.
  2. Clona el teu fork en el teu dispositiu.
  3. Triar el tipus d'aportació que vols fer, que pot ser una de les següents opcions:

    Tingues en compte les consideracions de l'apartat Format de les contribucions!

    • Crea una branca llibre/titol-del-llibre, indicant el títol del llibre.
    • Crea un fitxer dins del directori llibres amb el nom titol-del-llibre.md.
    • Afegeix la informació del llibre al fitxer creat seguint el format:

      # [Títol del llibre]
      - __Autor__: [Autor del llibre]
      - __Any de publicació__: [Any de publicació]
      
      ## Sinopsi
      [Sinopsi del llibre.]
      
      ## Gèneres
      - [Gènere 1]
      - [Gènere 2]
      - ...
      
    • Crea una branca pelicula/titol-de-la-pelicula, indicant el títol de la pel·lícula.
    • Crea un fitxer dins del directori pelicules amb el nom titol-de-la-pelicula.md.
    • Afegeix la informació de la pel·lícula al fitxer creat seguint el format:

      # [Títol de la pel·lícula]
      
      ## Sinopsi
      [Sinopsi de la pel·lícula.]
      
      ## Gèneres
      - [Gènere 1]
      - [Gènere 2]
      - ...
      
      ## Repartiment
      [Directors, actrius i actors principals.]
      
    • Crea una branca serie/titol-de-la-serie, indicant el títol de la sèrie.
    • Crea un fitxer dins del directori series amb el nom titol-de-la-serie.md.
    • Afegeix la informació de la sèrie al fitxer creat seguint el format:

      # [Títol de la sèrie]
      
      ## Sinopsi
      [Sinopsi de la sèrie.]
      
      ## Gèneres
      - [Gènere 1]
      - [Gènere 2]
      - ...
      
      ## Temporades
      [Nombre de temporades de la sèrie i títol de cada temporada.]
      

    Pots consultar les Incidències del repositori i tractar de resoldre-la.

    El nom de la branca ha de ser descriptiu de la incidència que vols resoldre, per exemple fix/... o issue/....

    Edita els camps entre [...] amb la informació corresponent.

  4. Publica la branca amb els canvis realitzats al teu repositori.

  5. Crea una Pull Request amb els canvis realitzats a la branca main del repositori original.
    • Afegeix un títol amb el format: Llibre/Pel·lícula/Sèrie: Títol de la contribució.
    • Afegeix una descripció detallada de la teua aportació.

A partir d'aquest punt estigues atent!

Aniré revisant les sol·licituds d'incorporació i pot ser indique que heu de fer alguna modificació.

La tasca es considerarà superada quan la teua Pull Request siga acceptada i fusionada al repositori principal.

Format de les contribucions

Per a garantir la coherència i la qualitat de les contribucions, és important seguir el format establert en l'enunciat per a cada tipus d'aportació.

A més, és important seguir les següents consideracions:

  • Els títols de les seccions han de ser consistents i no han de mesclar text en diferents llengües.

    Pots triar fer-ho tot en valencià o tot en castellà, però no s'han de mesclar les llengües en el mateix document. Si cal, has de modificar els títols de les seccions per adaptar-los a la llengua que has triat.

  • Els fitxers no han de contindre errors ortogràfics ni gramaticals.

    Revisa el text abans de publicar la Pull Request per assegurar-te que no hi ha errors.

  • El document ha de tindre un format Markdown correcte.

    Revisa el format del document abans de publicar la Pull Request per assegurar-te que el format és correcte i que es visualitza bé (ho pots fer des de GitHub o a Markdown Live Preview).

  • Evita crear duplicats de les aportacions ja existents. Pots ampliar aportacions anteriors, però no crear una aportació que ja existeix.

    Revisa el repositori abans de crear la teua aportació per assegurar-te que no hi ha una aportació similar a la que vols fer.

Revisió de les aportacions

Un cop creada la teua Pull Request, caldrà esperar a que siga revisada. Durant la revisió, es poden fer comentaris i suggeriments per millorar la teua aportació.

En cas de que es demane fer alguna modificació, caldrà realitzar els canvis indicats a la branca que has creat i publicar-los al teu repositori. La Pull Request s'actualitzarà automàticament amb els nous commits realitzats a la branca.

Ampliació

Com a ampliació, pots revisar el repositori en busca d'errors o incidències, que pots comunicar mitjançant l'apartat Incidències.

📌 Aquest document pot quedar desactualitzat després d’imprimir-lo. Pots consultar la versió més recent a la pàgina web.
🌿 Abans d’imprimir aquest document, considera si és realment necessari. Redueix el consum de paper i ajuda a protegir el nostre entorn.