Les revisions de codi són una part essencial del desenvolupament de programari col·laboratiu. Permeten que els equips millorin la qualitat del codi, detectin errors i comparteixin coneixements. En aquest tema, aprendrem com utilitzar Git per facilitar les revisions de codi.
- Què és una Revisió de Codi?
Una revisió de codi és el procés de revisar el codi escrit per un altre desenvolupador per assegurar-se que compleix amb els estàndards de qualitat, és correcte i és fàcil de mantenir. Les revisions de codi poden ser formals o informals i poden implicar eines automatitzades o simplement la lectura del codi.
- Beneficis de les Revisions de Codi
- Millora de la Qualitat del Codi: Identificació d'errors i millora de la qualitat general del codi.
- Compartició de Coneixements: Els desenvolupadors aprenen els uns dels altres.
- Estàndards de Codi: Assegura que el codi compleix amb els estàndards de l'equip.
- Col·laboració: Fomenta la col·laboració i la comunicació dins de l'equip.
- Eines per a Revisions de Codi amb Git
3.1. GitHub Pull Requests
GitHub és una de les plataformes més populars per a la col·laboració en codi i ofereix una funcionalitat robusta per a les revisions de codi a través de les "Pull Requests".
Crear una Pull Request
-
Crea una branca nova:
git checkout -b feature/nova-funcionalitat
-
Fes canvis i commiteja'ls:
git add . git commit -m "Afegeix nova funcionalitat"
-
Empeny la branca al repositori remot:
git push origin feature/nova-funcionalitat
-
Crea una Pull Request a GitHub:
- Ves al repositori a GitHub.
- Fes clic a "Compare & pull request".
- Afegeix una descripció i assigna revisors.
Revisar una Pull Request
-
Accedeix a la Pull Request:
- Ves a la pestanya "Pull requests" del repositori.
- Selecciona la Pull Request que vols revisar.
-
Revisa els canvis:
- Utilitza la vista de "Files changed" per veure els canvis línia per línia.
- Afegeix comentaris a línies específiques si cal.
-
Aprova o sol·licita canvis:
- Si els canvis són acceptables, fes clic a "Approve".
- Si calen canvis, fes clic a "Request changes" i proporciona feedback.
3.2. GitLab Merge Requests
GitLab ofereix una funcionalitat similar a les Pull Requests de GitHub, anomenada "Merge Requests".
Crear una Merge Request
-
Crea una branca nova:
git checkout -b feature/nova-funcionalitat
-
Fes canvis i commiteja'ls:
git add . git commit -m "Afegeix nova funcionalitat"
-
Empeny la branca al repositori remot:
git push origin feature/nova-funcionalitat
-
Crea una Merge Request a GitLab:
- Ves al repositori a GitLab.
- Fes clic a "Merge Requests" i després a "New merge request".
- Selecciona la branca i crea la Merge Request.
Revisar una Merge Request
-
Accedeix a la Merge Request:
- Ves a la pestanya "Merge Requests" del repositori.
- Selecciona la Merge Request que vols revisar.
-
Revisa els canvis:
- Utilitza la vista de "Changes" per veure els canvis línia per línia.
- Afegeix comentaris a línies específiques si cal.
-
Aprova o sol·licita canvis:
- Si els canvis són acceptables, fes clic a "Approve".
- Si calen canvis, fes clic a "Request changes" i proporciona feedback.
- Bones Pràctiques per a les Revisions de Codi
- Sigues Respectuós: Proporciona feedback constructiu i respectuós.
- Sigues Clar: Sigues específic en els teus comentaris.
- Revisa Regularment: Fes revisions de codi de manera regular per evitar acumulacions.
- Utilitza Eines Automatitzades: Utilitza eines com linters i analitzadors de codi estàtic per detectar problemes automàticament.
- Exercici Pràctic
Exercici: Crear i Revisar una Pull Request
-
Crea una nova branca anomenada
feature/exercici
:git checkout -b feature/exercici
-
Afegeix un fitxer nou anomenat
exercici.txt
amb el contingut "Hola, món!":echo "Hola, món!" > exercici.txt
-
Commet els canvis:
git add exercici.txt git commit -m "Afegeix exercici.txt"
-
Empeny la branca al repositori remot:
git push origin feature/exercici
-
Crea una Pull Request a GitHub i assigna un company per revisar-la.
-
Revisa la Pull Request del teu company, proporciona feedback i aprova-la o sol·licita canvis.
Solució
Aquest exercici és pràctic i no té una solució única. L'objectiu és familiaritzar-se amb el procés de creació i revisió de Pull Requests.
Conclusió
Les revisions de codi són una eina poderosa per millorar la qualitat del codi i fomentar la col·laboració dins dels equips de desenvolupament. Utilitzant Git i plataformes com GitHub o GitLab, podem integrar les revisions de codi en el nostre flux de treball de manera eficient. Practicar aquestes tècniques ens ajudarà a convertir-nos en desenvolupadors més efectius i col·laboratius.
Dominar Git: De Principiant a Avançat
Mòdul 1: Introducció a Git
Mòdul 2: Operacions Bàsiques de Git
- Creant un Repositori
- Clonant un Repositori
- Flux de Treball Bàsic de Git
- Preparant i Cometent Canvis
- Veient l'Historial de Commits
Mòdul 3: Branques i Fusió
- Entenent les Branques
- Creant i Canviant de Branques
- Fusionant Branques
- Resolent Conflictes de Fusió
- Gestió de Branques
Mòdul 4: Treballant amb Repositoris Remots
- Entenent els Repositoris Remots
- Afegint un Repositori Remot
- Recuperant i Traient Canvis
- Empenyent Canvis
- Seguint Branques
Mòdul 5: Operacions Avançades de Git
Mòdul 6: Eines i Tècniques de Git
Mòdul 7: Estratègies de Col·laboració i Flux de Treball
- Forking i Pull Requests
- Revisions de Codi amb Git
- Flux de Treball Git Flow
- GitHub Flow
- Integració Contínua amb Git
Mòdul 8: Millors Pràctiques i Consells de Git
- Escrivint Bons Missatges de Commit
- Mantenint un Historial Netejat
- Ignorant Fitxers amb .gitignore
- Millors Pràctiques de Seguretat
- Consells de Rendiment
Mòdul 9: Resolució de Problemes i Depuració
- Problemes Comuns de Git
- Desfent Canvis
- Recuperant Commits Perduts
- Tractant amb Repositoris Corruptes
- Tècniques Avançades de Depuració