Documentazione della revisione del codice

Question

Documentazione della revisione del codice

#1 da (1 voti)
#2 da (1 voti)

5

In un progetto abbiamo una revisione del codice piuttosto formale, attualmente eseguita manualmente e documentata in fogli Excel e documenti Word.

Vorremmo migliorare l'attuale processo di revisione del codice integrandolo in un flusso di lavoro Git (utilizzando strumenti come Bitbucket Server, che abbiamo già, Gerrit, ecc.).

L'idea corrente è che ogni sviluppatore implementa funzionalità e correzioni di bug e crea una richiesta di pull. Questa richiesta di pull viene esaminata da altri sviluppatori e quindi integrata nel nostro ramo di sviluppo principale o no.

Vorremmo esportare tutte le richieste pull (che ora sono le revisioni del codice) per documentarle formalmente in un documento offline. Questo documento di revisione del codice è un articolo di consegna per il nostro cliente.

Questo è un approccio fattibile?

git code-reviews gerrit

posta Simon 11.01.2016 - 12:22

fonte

2 risposte

Leggi altre domande sui tag git code-reviews gerrit

È confuso non memorizzare il numero di versione di un progetto nel codice sorgente? Come dovrei gestire una risposta HTTP il cui corpo richiede tempo per generare e le cui intestazioni non possono essere determinate fino al completamento della generazione?

score 1 · Answer 1

Puoi dare un'occhiata a Phabricator . È una bella applicazione di gestione di progetti software all-in-one che gestisce le revisioni del codice in modo simile a quello che hai descritto e fa molto di più sullo sviluppo del software.

Non voglio raccomandarti uno strumento, ma voglio mostrarti che idea hanno sulle revisioni del codice, che considero solide e praticabili.

L'intero processo di sviluppo all'interno di Phabricator è documentato, non solo recensioni di codice, perché collega tutte le informazioni utilizzando identificatori che vengono tradotti automaticamente in link e producono riferimenti con date, orari e utenti coinvolti nelle azioni.

Ecco come appare una revisione del codice in Phabricator (per rispondere in modo specifico alla tua domanda):

Lo sviluppatore crea un nuovo ramo nel repository git locale e fa un commit con le sue modifiche.
Lo sviluppatore avvia arc diff per filtrare e testare le modifiche e creare una revisione del codice (chiamata "differenziale"). Alcuni metadati possono essere aggiunti a questo punto.
Phabricator riceve il differenziale e lo rende disponibile ad altri sviluppatori in questo progetto.
Altri sviluppatori possono commentare il changeset e annotarlo. L'autore può aggiornare il differenziale.
I revisori possono accettare o rifiutare il differenziale.
L'autore può quindi abbandonare il differenziale o eseguirne il commit ( arc land ).
Il repository riceve il commit e lo collega automaticamente con il differenziale. E il differenziale è anche cablato con il commit e / o le azioni che portano al risultato.

Phabricator è sviluppato molto rapidamente ed è esso stesso sviluppato in una propria istanza pubblica di Phabricator .

score 1 · Answer 2

Server di Bitbucket può certamente fare questo, ha API REST per l'estrazione dei dati delle richieste di pull). Se desideri qualcosa di più specifico nel prodotto, è disponibile l' plug-in SDK per generare automaticamente i documenti.

Come altri hanno suggerito, questo potrebbe essere un buon momento per esaminare ciò di cui i tuoi clienti hanno bisogno (o pensano di aver bisogno) e quali altri modi che potrebbero essere catturati e consegnati. Può darsi che tu stia già considerando la migliore opzione disponibile, ma potrebbero esserci alternative più snelle che ti fanno risparmiare tempo e denaro.

Divulgazione: lavoro per Atlassian