Guida ai messaggi di commit

Messaggi di commit

Messaggi di commit chiari semplificano la revisione delle richieste di pull e la generazione delle note di rilascio. Il progetto Blockly utilizza commit convenzionali per facilitare questa operazione.

Ogni commit deve avere il formato:

<type>: <description>

[optional body]

[optional footer(s)]

Tieni presente che il repository principale di Blockly ha un linter di commit per contribuire a far rispettare questa norma. Se la tua richiesta di pull ha più commit, il linter controllerà il titolo. Se ha un solo commit, verrà controllato. È consigliabile che sia i singoli commit sia il titolo della richiesta di pull rispettino queste linee guida.

Tipo

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

  • chore: per i commit che completano attività di routine/automatizzate come l'upgrade delle dipendenze.

  • deprecate: per i commit che ritirano funzionalità.

  • feat: per i commit che aggiungono nuove funzionalità a Blockly.

  • fix: per i commit che correggono 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 errori devono aggiungere un ! dopo il tipo di commit. Le modifiche che causano interruzioni sono modifiche che potrebbero interrompere gli sviluppatori che utilizzano Blockly nelle loro app, costringendoli a svolgere un lavoro extra.

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

Le modifiche che causano interruzioni potrebbero essere di uno qualsiasi dei tipi validi sopra indicati.

Descrizione

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

Corpo

Il corpo è facoltativo. Se viene fornito, deve essere presente una riga vuota tra questo e la descrizione. Deve essere suddiviso in righe di massimo 256 caratteri.

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

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

Correzione dei commit non convenzionali

Se non hai utilizzato commit convenzionali quando hai apportato le modifiche, hai due opzioni per correggere i messaggi, a seconda del numero di commit:

  1. Se la tua richiesta pull ha più commit, modifica il titolo della richiesta 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 tua richiesta pull ha un solo commit, modifica il messaggio di commit utilizzando git commit --amend, quindi esegui il push forzato delle modifiche al fork di Blockly. In questo modo, tutte le richieste di pull aperte associate a questo ramo verranno aggiornate automaticamente. git push --force origin my-branch.