Guida al messaggio di commit

Esegui il commit dei messaggi

I messaggi di commit chiari semplificano la revisione delle richieste di pull e le note di rilascio sono più facili da generare. Il progetto Blockly utilizza i comandi convenzionali a questo scopo.

Ogni commit deve avere il formato:

<type>: <description>

[optional body]

[optional footer(s)]

Tieni presente che il repository Blockly principale ha un linter di commit per l'applicazione forzata. Se la richiesta di pull ha più commit, il linter controllerà il titolo. Se ha un singolo commit, lo controllerà. È preferibile che sia i singoli commit e il titolo della richiesta di pull seguano queste linee guida.

Tipo

Il tipo non deve essere vuoto e deve essere tutto minuscolo. Di seguito è riportato un elenco dei tipi accettati.

lavoro di routine
Per i commit che completano attività di routine/automatizzate come l'upgrade delle dipendenze.
ritira
Per i commit che deprecano la funzionalità.
feat
Per i commit che aggiungono nuove funzionalità a Blockly.
fix
Per i commit che risolvono bug/errori in Blockly.
release
Per i commit relativi al rilascio di una nuova versione.

Modifiche che provocano un errore

I commit che apportano modifiche che provocano un errore devono aggiungere un valore ! dopo il tipo di commit. Le modifiche che provocano un errore sono modifiche che potrebbero interrompere l'utilizzo di Blockly nelle loro app per gli sviluppatori, costringendoli a svolgere ulteriori operazioni.

Ad esempio: fix!: return type of workspace.paste

Le modifiche che provocano un errore possono avere uno qualsiasi dei tipi validi sopra indicati.

Descrizione

La descrizione non può essere vuota e deve contenere meno di 256 caratteri.

Body

Il corpo è facoltativo. Se viene specificato, deve esserci una riga vuota tra il testo e la descrizione. Deve essere suddiviso in righe di massimo 256 caratteri.

Tieni presente che, di solito, è consigliabile inserire questo tipo di informazioni nella descrizione della richiesta pull, oltre che direttamente nel commit.

Il piè di pagina è facoltativo. Se viene fornito, deve esserci una linea vuota tra il testo e il corpo. Deve essere suddiviso in righe di massimo 256 caratteri.

Correzione dei commit non convenzionali

Se non hai utilizzato commissioni convenzionali durante le modifiche, esistono due opzioni per correggere i messaggi a seconda del numero di commit di cui disponi:

  1. Se la richiesta di pull ha più commit, modifica il titolo della richiesta di pull in modo che sia conforme ai requisiti. Quando la richiesta di pull viene unita, gli altri commit vengono compressi in modo che il titolo diventi il messaggio di commit.

  2. Se la richiesta di pull ha un singolo commit, modifica il messaggio di commit utilizzando git commit --amend, quindi forza il push delle modifiche al fork di Blockly. Verranno aggiornate automaticamente tutte le richieste di pull aperte associate a questo ramo. git push --force origin my-branch.