Concetti fondamentali di Git
Repository
Repository
L’origine della tua documentazione, dove sono archiviati tutti i file e la loro cronologia. L’Editor web si connette al repository per accedere ai contenuti e modificarli.
Commit
Commit
Un’istantanea salvata delle modifiche in un momento specifico. Ogni commit include un messaggio che descrive cosa è cambiato e crea un record permanente nella cronologia del progetto.
Branch
Branch
Un branch punta a un commit specifico nel repository. La documentazione live viene generata a partire da un branch di deployment. Puoi avere qualsiasi numero di altri branch con modifiche non ancora pubblicate sulla documentazione live. Se vuoi integrare le modifiche di un branch nella documentazione live, puoi eseguire il merge del branch nel branch di deployment tramite una pull request.Usa i branch per lavorare sui cambiamenti senza influenzare la documentazione live, sperimentare in sicurezza nuove funzionalità e ottenere revisioni prima della pubblicazione.
Deployment branch
Deployment branch
Il branch principale del progetto da cui viene generato il contenuto della documentazione live. Le modifiche a questo branch vengono pubblicate automaticamente sul sito di documentazione. Spesso chiamato
main
, ma puoi impostare qualsiasi branch come branch di deployment.Pull request
Pull request
Un modo per proporre il merge delle modifiche da un branch nella documentazione live. Consente revisione e discussione prima che le modifiche diventino effettive. Comunemente chiamata PR; in GitLab è detta merge request.
Diff
Diff
Un diff (o differenza) mostra le modifiche tra due versioni di un file. Durante la revisione delle pull request, i diff evidenziano ciò che è stato aggiunto, rimosso o modificato, semplificando l’identificazione dei cambiamenti.
Come l’Editor web utilizza Git
L’Editor web si connette al tuo repository Git tramite la GitHub App o l’integrazione GitLab e automatizza le operazioni Git più comuni. Quando:- Apri un file: l’editor recupera l’ultima versione dal repository, assicurandoti di lavorare sempre con contenuti aggiornati.
- Apporti modifiche: l’editor tiene traccia delle modifiche come bozza, che può diventare un commit quando sei pronto a salvare il lavoro.
- Salvi le modifiche: l’editor crea un commit con le modifiche, preservando il lavoro nella cronologia del progetto.
- Crei un branch: l’editor crea un nuovo branch nel repository, utilizzabile da chiunque vi abbia accesso per collaborare e rivedere le modifiche.
- Pubblichi sul branch di deployment: l’editor esegue commit e push direttamente sul branch di deployment, pubblicando immediatamente le modifiche.
- Pubblichi su altri branch: l’editor apre una pull request, che ti consente di ottenere feedback da altri prima di unire le modifiche nel branch di deployment.
Best practice per Git
- Scrivi messaggi di commit descrittivi: Sii specifico su cosa è cambiato e usa un linguaggio attivo.
- Usa nomi di branch descrittivi: I nomi dei branch dovrebbero spiegare il lavoro svolto ed essere chiari per chi consulta i branch nel repository.
- Mantieni i branch mirati: Limita le modifiche in un branch a un’attività o a un progetto specifico.
- Elimina i branch dopo il merge: Elimina i branch quando non servono più per mantenere il repository ordinato.