Generazione modifiche introduttive, manualmente o automaticamente? Cosa è raccomandato?

5

Stavo leggendo ciò che è un log delle modifiche in keepachangelog.com e dice che non dovremmo abbandonare i nostri log git per la creazione di questo file, ma vedo che molti progetti lo fanno come il repository framework Angular, quindi mi chiedo quale sia la strategia consigliata per fare ciò, che tipo di utenti stiamo mirando o ai casi speciali in cui vorremmo rilasciare i nostri registri git in questo file invece di scriverli da soli.

Voglio sottolineare che sono nuovo in questo tipo di flusso di lavoro poiché la società per cui lavoro attualmente non ha mai utilizzato un log delle modifiche e VCS e sto cercando di organizzare meglio i progetti che sviluppiamo.

    
posta Otto Cheley 29.10.2018 - 18:20
fonte

2 risposte

15

Un registro delle modifiche dovrebbe indicare agli utenti finali perché dovrebbero essere aggiornati, non cosa è cambiato nel codice.

Rimanere concentrati sulle funzionalità e sulle correzioni dei bug fornite agli utenti finali del software, che si tratti di altri programmatori nel caso di librerie di codici, per i clienti della tua azienda o di persone non tecniche.

Cambia log come:

  • Added Comment.cs class file and data mapping
  • Fixed bug in main procedure
  • Fixed runtime cast exception

Indica agli utenti finali nulla sul motivo per cui aggiornerebbero. Sono pieni di gergo tecnico che nessuno capisce. Sono buone informazioni per altri sviluppatori, ma gli utenti finali non apprezzeranno queste informazioni.

Cambia log come:

  • Added comments feature to blog posts
  • Fixed issue #582 causing errors after logging in
  • Fixed issue #37 causing errors after double clicking the save button

Mostra il valore dell'aggiornamento, senza immergerti nei dettagli tecnici. Quando noti che hai risolto un difetto, se possibile, collega il rapporto stesso.

La cronologia dei commit del tuo progetto è probabilmente piena di gergo tecnico - e va bene! È la cronologia di commit del codice. Il pubblico previsto sono altri ingegneri del tuo team, non gli utenti finali.

Gestisci manualmente il registro delle modifiche.

    
risposta data 29.10.2018 - 18:30
fonte
-2

Generalmente a nessuno interessa i registri delle modifiche e, se lo fanno, probabilmente vogliono i dettagli gori di ogni commit o almeno l'id del ticket che hanno generato se è stato corretto.

Inserisci i numeri dei biglietti + le brevi descrizioni nel nome del ramo e arrotoli i tuoi commenti di commit di fusione in un registro delle modifiche.

Se stai pubblicando un registro delle modifiche con un prodotto commerciale, chiedi all'ufficio marketing di ripulire il registro delle modifiche vero e proprio in quello che a loro parere venderà più copie.

    
risposta data 29.10.2018 - 19:23
fonte

Leggi altre domande sui tag