mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-30 09:14:12 +02:00
Fix multiple identation errors
This commit is contained in:
parent
2a0df6b2a9
commit
92db66e139
@ -5,7 +5,6 @@ language: it-IT
|
|||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
|
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
|
||||||
- gemnasium = "https://gemnasium.com/"
|
- gemnasium = "https://gemnasium.com/"
|
||||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||||
@ -75,9 +74,9 @@ version: 1.0.0
|
|||||||
%li
|
%li
|
||||||
L'ultima versione viene prima.
|
L'ultima versione viene prima.
|
||||||
%li
|
%li
|
||||||
Viene mostrata la data di release di ogni versione.
|
Viene mostrata la data di release di ogni versione.
|
||||||
%li
|
%li
|
||||||
Si dichiara se il progetto segue il #{link_to "Versionamento Semantico", semver}.
|
Si dichiara se il progetto segue il #{link_to "Versionamento Semantico", semver}.
|
||||||
|
|
||||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||||
%h4#types Tipologie di cambiamenti
|
%h4#types Tipologie di cambiamenti
|
||||||
@ -109,8 +108,8 @@ version: 1.0.0
|
|||||||
Come posso ridurre gli sforzi necessari a mantenere un changelog?
|
Come posso ridurre gli sforzi necessari a mantenere un changelog?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Tieni una sezione <code>Unreleased</code> in cima al changelog in modo da tenere traccia
|
Tieni una sezione <code>Unreleased</code> in cima al changelog in
|
||||||
dei cambiamenti imminenti.
|
modo da tenere traccia dei cambiamenti imminenti.
|
||||||
|
|
||||||
%p Questo serve per due scopi:
|
%p Questo serve per due scopi:
|
||||||
|
|
||||||
@ -118,14 +117,16 @@ version: 1.0.0
|
|||||||
%li
|
%li
|
||||||
Le persone possono vedere quali modifiche si possono aspettare nelle future release.
|
Le persone possono vedere quali modifiche si possono aspettare nelle future release.
|
||||||
%li
|
%li
|
||||||
Ad una nuova release, si deve solo spostare i cambiamenti della sezione
|
Ad una nuova release, si deve solo spostare i cambiamenti della sezione
|
||||||
`"Unreleased"` in una nuova sezione con il suo numero di versione.
|
`"Unreleased"` in una nuova sezione con il suo numero di versione.
|
||||||
|
|
||||||
.bad-practices
|
.bad-practices
|
||||||
%h3#bad-practices
|
%h3#bad-practices
|
||||||
%a.anchor{ href: "#bad-practices", aria_hidden: "true" }
|
%a.anchor{ href: "#bad-practices", aria_hidden: "true" }
|
||||||
I changelog possono essere cattivi?
|
I changelog possono essere cattivi?
|
||||||
|
|
||||||
%p Si. Ecco alcuni modi in cui possono essere meno utili.
|
%p Si. Ecco alcuni modi in cui possono essere meno utili.
|
||||||
|
|
||||||
%h4#log-diffs
|
%h4#log-diffs
|
||||||
%a.anchor{ href: "#log-diffs", aria_hidden: "true" }
|
%a.anchor{ href: "#log-diffs", aria_hidden: "true" }
|
||||||
Commit log diffs
|
Commit log diffs
|
||||||
@ -212,34 +213,41 @@ version: 1.0.0
|
|||||||
%h4#github-releases
|
%h4#github-releases
|
||||||
%a.anchor{ href: "#github-releases", aria_hidden: "true" }
|
%a.anchor{ href: "#github-releases", aria_hidden: "true" }
|
||||||
Cosa dire delle GitHub Releases?
|
Cosa dire delle GitHub Releases?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
È una bella iniziativa. #{link_to "Releases", ghr} può essere usato
|
È una bella iniziativa. #{link_to "Releases", ghr} può essere usato
|
||||||
per rendere semplice i git tags (per esempio il nome del tag <code>v1.0.0</code>)
|
per rendere semplice i git tags (per esempio il nome del tag
|
||||||
All'interno di note di rilascio ben dettagliate si possono aggiungere le note manualmente oppure è possibile
|
<code>v1.0.0</code>) All'interno di note di rilascio ben dettagliate
|
||||||
utilizzare le note dei messaggi dei git tag inserendole dentro nelle note di rilascio.
|
si possono aggiungere le note manualmente oppure è possibile
|
||||||
j
|
utilizzare le note dei messaggi dei git tag inserendole dentro nelle
|
||||||
|
note di rilascio.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
GitHub Releases crea un changelog non-portable che può essere solo
|
GitHub Releases crea un changelog non-portable che può essere solo
|
||||||
visualizzato dagli utenti nel contesto di GitHub. È possibile farlo
|
visualizzato dagli utenti nel contesto di GitHub. È possibile farlo
|
||||||
apparire molto simile al formato di Keep a Changelog, tuttavia tende
|
apparire molto simile al formato di Keep a Changelog, tuttavia tende
|
||||||
ad essere un po' più complicato.
|
ad essere un po' più complicato.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
La versione corrente di GitHub Releases risulta inoltre probabilmente
|
La versione corrente di GitHub Releases risulta inoltre
|
||||||
poco rilevante per gli utenti finali, a differenza dei tipici file maiuscoli
|
probabilmente poco rilevante per gli utenti finali, a differenza dei
|
||||||
(<code>README</code>, <code>CONTRIBUTING</code>, etc.). Un altro problema
|
tipici file maiuscoli (<code>README</code>,
|
||||||
minore è che l'interfaccia non offre attualmente link per la
|
<code>CONTRIBUTING</code>, etc.). Un altro problema minore è che
|
||||||
creazione di log tra ciascuna release.
|
l'interfaccia non offre attualmente link per la creazione di log tra
|
||||||
|
ciascuna release.
|
||||||
|
|
||||||
%h4#automatic
|
%h4#automatic
|
||||||
%a.anchor{ href: "#automatic", aria_hidden: "true" }
|
%a.anchor{ href: "#automatic", aria_hidden: "true" }
|
||||||
I changelog possono essere analizzati automaticamente?
|
I changelog possono essere analizzati automaticamente?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
È difficile, perché le persone usano formati e nomi di file profondamente diversi.
|
È difficile, perché le persone usano formati e nomi di file
|
||||||
|
profondamente diversi.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
#{link_to "Vandamme", vandamme} è una Ruby gem
|
#{link_to "Vandamme", vandamme} è una Ruby gem creata dal team
|
||||||
creata dal team #{link_to "Gemnasium", gemnasium} ed è in grado di fare il parsing dei
|
#{link_to "Gemnasium", gemnasium} ed è in grado di fare il parsing dei
|
||||||
change log di molti (ma non tutti) i progetti open source.
|
change log di molti (ma non tutti) i progetti open source.
|
||||||
|
|
||||||
|
|
||||||
%h4#yanked
|
%h4#yanked
|
||||||
@ -247,17 +255,18 @@ version: 1.0.0
|
|||||||
Cosa sono le release "yanked"?
|
Cosa sono le release "yanked"?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Le release "yanked" sono versioni che sono state rimosse a causa di bug seri
|
Le release "yanked" sono versioni che sono state rimosse a causa di
|
||||||
o problemi di sicurezza. Spesso queste versioni non appaiono nei change
|
bug seri o problemi di sicurezza. Spesso queste versioni non
|
||||||
log. Invece dovrebbero esserci, nel seguente modo:
|
appaiono nei change log. Invece dovrebbero esserci, nel seguente
|
||||||
|
modo:
|
||||||
|
|
||||||
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
|
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
|
||||||
|
|
||||||
%p
|
%p
|
||||||
L'etichetta <code>[YANKED]</code> è in maiuscolo per un motivo.
|
L'etichetta <code>[YANKED]</code> è in maiuscolo per un motivo.
|
||||||
È importante che le persone la notino.
|
È importante che le persone la notino.
|
||||||
Poiché è racchiusa tra parentesi quadre è anche
|
Poiché è racchiusa tra parentesi quadre è anche
|
||||||
più semplice da riconoscere nel parsing automatizzato.
|
più semplice da riconoscere nel parsing automatizzato.
|
||||||
|
|
||||||
|
|
||||||
%h4#rewrite
|
%h4#rewrite
|
||||||
@ -266,13 +275,13 @@ version: 1.0.0
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Certo. Ci sono sempre buoni motivi per migliorare un changelog. Io apro regolarmente
|
Certo. Ci sono sempre buoni motivi per migliorare un changelog. Io apro regolarmente
|
||||||
delle pull request per aggiungere release mancanti ai progetti open source che non mantengono
|
delle pull request per aggiungere release mancanti ai progetti open source che non mantengono
|
||||||
correttamente i changelog.
|
correttamente i changelog.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
È anche possibile che si scopra di aver dimenticato di annotare una modifica
|
È anche possibile che si scopra di aver dimenticato di annotare una modifica
|
||||||
non retro-compatibile nelle note per una versione. Ovviamente è importante aggiornare
|
non retro-compatibile nelle note per una versione. Ovviamente è importante aggiornare
|
||||||
il changelog in questo caso.
|
il changelog in questo caso.
|
||||||
|
|
||||||
%h4#contribute
|
%h4#contribute
|
||||||
%a.anchor{ href: "#contribute", aria_hidden: "true" }
|
%a.anchor{ href: "#contribute", aria_hidden: "true" }
|
||||||
@ -280,11 +289,11 @@ version: 1.0.0
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Questo documento non è la <strong>verità assoluta</strong>; è solo la mia attenta
|
Questo documento non è la <strong>verità assoluta</strong>; è solo la mia attenta
|
||||||
opinione, arricchita dalle informazioni ed esempi che ho raccolto.
|
opinione, arricchita dalle informazioni ed esempi che ho raccolto.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Questo è perché voglio che la nostra comunità raggiunga un consenso. Credo che
|
Questo è perché voglio che la nostra comunità raggiunga un consenso. Credo che
|
||||||
la discussione sia importante almeno quanto il risultato finale.
|
la discussione sia importante almeno quanto il risultato finale.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Quindi per favore <strong>#{link_to "partecipate e dateci dentro", gh}</strong>.
|
Quindi per favore <strong>#{link_to "partecipate e dateci dentro", gh}</strong>.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user