Commit Convenzionali 1.0.0-beta

Riepilogo

Da maintainer di codice open source, devo poter scrivere messaggi standardizzati per i commit ed eseguire lo squash dei feature branch nel master.

I messaggi dei commit dovrebbero seguire la seguente struttura:

<tipo>[contesto opzionale]: <descrizione>

[corpo opzionale]

[piè di pagina opzionale]

Il commit contiene i seguenti elementi strutturali, allo scopo di comunicarne l’intento al consumatore della libreria:

1. fix: un commit di tipo fix risolve un errore nel codice (correlato al PATCH in un versionamento semver).
2. feat: un commit di tipo feat introduce una nuova funzionalità al codice (correlato al MINOR in un versionamento semver).
3. BREAKING CHANGE: un commit che contiente il testo BREAKING CHANGE: all’inizio delle sezioni opzionali corpo o piè di pagina, introduce una breaking API change (correlato al Major in un versionamento semver). Una breaking change può essere parte di entrambi i tipi fix: w feat:.
   Un contesto potrebbe essere aggiunto al tipo di commit, al fine di offrire ulteriori informazioni contestuali. Da aggiungere tra delle parentesi tonde, Es: feat(parser): add ability to parse arrays.

Sono ammessi altri tipi oltre fix: e feat:, ad esempio la convenzione Angular raccomanda docs:, style:, refactor:, perf:, test:, chore:, ma questi non sono coperti da questa specifica.

Introduzione

Nello sviluppo software, secondo la mia esperienza, gli errori sono spesso introdotti ai limiti tra le applicazioni.

I test unitari vanno benissimo per le interazioni che i mantenitori open source conoscono, ma non fanno un ottimo lavoro nel catturare tutti i modi interessanti, spesso inaspettati, con i quali la comunità utilizza una libreria.

Solamente chi ha visto la propria applicazione restituire errori 500 dopo aver aggiornato una dipendenza ad una nuova versione patch, sa quanto sia importante una cronologia di commit facilmente leggibile (e nel migliore dei casi un changlelog ben mantenuto) per il processo di investigazione che dovrà affrontare.

La specifica per commit convenzionali propone l’introduzione di una convenzione facilmente applicabile ai messaggi dei commit. Questa convenzione legata al SemVer, chiede ai sviluppatori software di descrivere nei messaggi dei commit qualsiasi feature, fix e breaking change loro abbiano fatto.

Introducendo questa convenzione, si crea un linguaggio comune che rende più semplice rimuovere errori tra progetti.

Specifica Commit Convenzionali

Le parole “DEVE”, “NON DEVE”, “RICHIESTO”, “DOVRÀ”, “NON DOVRÀ”, “DOVREBBE”, “NON DOVREBBE”, “RACCOMANDATO”, “POTREBBE” e “OPZIONALE” devo essere interpretata come da specifica RFC 2119.

1. Un commit DEVE iniziare con un tipo, il quale consiste in un verbo, feat, fix, etc., seguito dai due punti ed uno spazio.
2. Il tipo feat DEVE essere usato quando un commit aggiunge una funzionalità all’applicazione o libreria.
3. Il tipo fix DEVE essere usato quando un commit corregge un errore all’applicazione o libreria.
4. Un contesto opzionale POTREBBE essere fornito dopo il tipo. Un contesto rappresenta una sezione dell’applicazione o libreria, il contentuo va racchiusa tra delle parentesi. Es: fix(parser):
5. Una descrizione DEVE seguire immediatamente il tipo (con eventuale contesto). Per descrizione si intende una breve spiegazione della pull request. Es: fix: array parsing issue when multiple spaces were contained in string.
6. Un corpo del commit più lungo POTREBBE essere aggiunto dopo una breve descrizione. Il corpo DEVE inizare dopo una linea vuota dalla descrizione.
7. Un piè di pagina POTREBBE essere aggiunto inserendo una linea vuota dopo il corpo. Il piè di pagina DOVREBBE contenere ulteriori informazioni riguardo la pull request (come le issue che risolve, Es: fixes #13, #5).
8. Una breaking changes DEVE essere indicata all’inizio delle sezioni piè di pagina o del corpo del commit. Una breaking change DEVE essere scritta in maiuscolo BREAKING CHANGE, seguita dai due punti ed uno spazio.
9. Una descrizione DEVE essere aggiunta dopo il testo BREAKING CHANGE: , descrivendo il cambiamento delle API. Es: BREAKING CHANGE: environment variables now take precedence over config files.
10. Un commit POTREBBE utilizzare altri tipi al di fuori di feat e fix nel messagio.

Perchè utilizzare commit convenzionali

• CHANGELOG generati automaticamente.
• Determina automaticamente l’incremento di un versionamento semver (basandosi sui tipi di commit utilizzati).
• Comunica la natura dei cambiamenti a colleghi, pubblico, o altri parti interessate.
• Attiva build e processi di rilascio.
• Rendi più semplice alle persone contribuire al tuo progetto, dando la possibilità di espolrare una cronologia di commit più strutturata.

FAQ

Come dovrei comportarmi con i messaggi dei commit nella fase iniziale del progetto?

Raccomandiamo di procedere come se il tuo prodotto sia già stato rilasciato. Tipicamente qualcuno, anche i tuoi colleghi, stanno utilizzando il tuo software. Loro vorranno sapere cosa sia stato risolto, cosa si sia rotto etc.

Cosa faccio se il tipo di commit è conforme a più di un tipo?

Torna indietro e dividi in più commit dove puoi. Parte del beneficio di usare Commit Convenzionali è quello di spingerti a fare commit e pull request più organizzati.

Non disincoraggia sviluppo ed iterazioni rapidi?

Disingoraggia farlo in una maniere disorgaizzata. Inoltre ti aiuterà a muoverti più velocemente su più progetti con diversi contributori.

Potrebbe Commit Convenzionali limitare gli sviluppatori a fare solamente alcuni tipi commit perchè penseranno nei tipi forniti dalla specifica?

Commit Convenzionali ti incoraggia nel fare più di certi tipi di commit. Inoltre la flessibilità di Commit Convenzionali consente al tuo team di inventare i propri tipi e cambiarli nel tempo.

Come si collega a SemVer?

I commit di tipo fix dovrebbero essere traducibili ai rilasci PATCH. I commit di tipo feat dovrebbero essere traducibili ai rilasci MINOR. I commit con BREAKING CHANGE, indipentemente dal tipo, dovrebbero essere traducibili ai rilasci MAJOR.

Come dovrei versionare le mie estensioni per la specifica Commit Convenzionali? (Es: @jameswomack/conventional-commit-spec)

Raccomandiamo l’utilizzo di SemVer per rilasciare la tua estensione (crea delle estensioni!)

Cosa faccio se accidentalmente utilizzo un tipo di commit sbagliato?

Quando usi un tipo della specifica ma non quello giusto (Es: fix invece di feat)

Se ancora devi creare il merge o il rilascio dell’errore, raccomandiamo l’utilizzo di git rebase -i per riscrivere la cronologia dei commit. Nel caso ti abbia già rilasciato questa correzzione dipende dai tool e processi che usi.

Quando usi un tipo non della specifica (Es: feet invece di feat)

Non è la fine del mondo se un commit non segue la specifica Commit Convenzionali. Semplicemente il commit verrà ignorato dai tool che sono basati su questa specifica.

Devono tutti i contributori seguire la specifica Commit Convenzionali?

No. Se usi un workflow basato sugli squash di Git, i mantenitori possono pulire i messaggi dei commit mentre vengono inseriti nel branch principale (merge), non aggiungendo alcun carico di lavoro ai committer occasionali. Un workflow comune è quello di unire (con lo squash) automaticamente i commit dalle pull request e far utilizzare un form ai mantenitori per riscrivere un messaggio più adeguato.

Riguardo

La specifica Commit Convenzionali è ispirata e fortemente basata su Angular Commit Guidelines.

La prima bozza di questa specifica è stata scritta in collaborazione con alcuni contributori di:

• conventional-changelog: un set di tool per analizzare messagi dei commit convenzionali dalla cronologia git.
• unleash: un tool per automatizzare rilasci e cicli di pubblicazioni di un software.
• lerna: un tool per la gestione di monorepos, nato del progetto Babel.

Progetti che usano Commit Convenzionali

• yargs: Parser di argomenti da CLI, a tema pirati.
• istanbuljs: Una collezione di strumenti e librerie open source per aggiungere la coverage dei test JavaScript.
• standard-version: Automatizza il versionamento e la gestione del CHANGELOG utilizzando il nuovo pulsante squash di GitHub e il flusso di lavoro consigliato da Commit Convenzionali.

vuoi aggingere il tuo progetto alla lista? invia una pull request.

Licenza

Creative Commons - CC BY 3.0