Salta el contingut
 

Exercici: Col·laboració mitjançant Pull Requests

Joan Puigcerver Ibáñez

Llicència: CC BY-NC-SA 4.0

(Reconeixement - NoComercial - CompartirIgual) 🅭

Objectius

Aquest exercici permet practicar la col·laboració en un projecte real mitjançant Pull Requests. En acabar, has de saber:

  • Crear una bifurcació (fork) d'un projecte.
  • Crear una Pull Request.
  • Col·laborar en un projecte mitjançant Pull Requests.

Lliurament

Per a lliurar aquest exercici, només cal que indiques en la bústia de l'exercici la URL de la Pull Request que has creat.

Enunciat

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

La tasca d'aquest bloc consisteix a fer una aportació a aquest repositori. Per fer-ho, segueix aquests passos:

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

    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.
    • Afig 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.
    • Afig 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.
    • Afig 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.]
      

    Consulta les incidències del repositori i intenta resoldre'n alguna.

    El nom de la branca ha de descriure 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 en el teu repositori.

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

A partir d'aquest punt, estigues atent o atenta a la teua Pull Request.

Revisaré les sol·licituds d'incorporació i és possible que t'indique que cal 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, segueix el format establert en l'enunciat per a cada tipus d'aportació. A més, tingues en compte les consideracions següents:

  • Llengua: els títols de les seccions han de ser coherents i no han de mesclar diferents llengües.

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

  • Ortografia: els fitxers no han de contindre errors ortogràfics ni gramaticals.

    Revisa el text abans de publicar la Pull Request.

  • Format: el document ha de tindre un format Markdown correcte.

    Comprova que el document es visualitza correctament abans de publicar la Pull Request. Ho pots fer des de GitHub o amb Markdown Live Preview.

  • Duplicats: no crees una aportació que ja existeix. Pots ampliar aportacions anteriors, però no duplicar-les.

    Revisa el repositori abans de crear la teua aportació per a assegurar-te que no n'hi ha cap de semblant.

Revisió de les aportacions

Una vegada creada la teua Pull Request, cal esperar que es revise. Durant la revisió, es poden fer comentaris i suggeriments per a millorar la teua aportació.

Si es demana alguna modificació, fes els canvis indicats en la branca que has creat i publica'ls en el teu repositori. La Pull Request s'actualitza automàticament amb els commits nous de la branca.

Ampliacions

Si has acabat l'exercici, pots aprofundir amb aquesta proposta:

  • Revisa el repositori a la recerca d'errors i comunica'ls 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.