Come stabilire una serie di regole quando più team gestiscono un singolo codice base

3

Abbiamo diversi team nella nostra sezione dell'organizzazione e ciascuno offrirà funzionalità del sistema per lo sviluppo e l'implementazione.

Una funzionalità include il lavoro di back-end e il lavoro front-end. Tutti i team utilizzeranno due basi di codice. Quelli sono la base di codice di back-end e la base di codice di front-end.

Il requisito è creare una serie di linee guida da seguire durante la codifica.

  1. Regole da seguire quando si esegue il commit. Stili e standard da seguire quando codifica.
  2. Istruzioni da seguire quando si dirama.
  3. Stili e standard da seguire quando inserisci commenti nel codice.
  4. Stili e standard da seguire quando si modifica la struttura di il codice e ecc.

Scopo di queste regole sarà mantenere la qualità del codice. Ci sono delle linee guida da seguire quando si impostano questi tipi di regole?

    
posta Harshakj89 21.11.2016 - 09:33
fonte

2 risposte

4

Are there any guide lines to follow when setting up these kind of rules?

Sì:

  1. Non imporre, ad esempio, le regole di una squadra a tutti gli altri, o creare nuove regole nuove che nessuna squadra attualmente utilizza. Cerca di raggiungere un consenso su qualsiasi pratica corrente e usale come regole

  2. Automatizza tutto (dato che nessuno leggerà le tue regole)

Ad esempio, è possibile che il criterio di diramazione sia "creare un ramo denominato con il numero di attività", in tal caso creare una semplice app interna che possa essere utilizzata da tutti per la denominazione corretta.

Allo stesso modo con gli standard di codifica, per quanto possibile usa strumenti automatici per applicarli e farli eseguire automaticamente al check-in, o subito dopo tramite un processo di CI.

Per chiarire l'applicazione delle regole del formato del codice. Anche se esistono strumenti automatici per la formattazione, dovrebbero essere trattati con cura. Molte lingue però hanno strumenti "linting" in grado di analizzare il codice per conflitti con le regole di formattazione. Li preferirei personalmente, ma è una questione di preferenze personali.

    
risposta data 21.11.2016 - 11:52
fonte
3

Oltre all'eccellente risposta di David Arno, usa le convenzioni esistenti quando la squadra non ha una ferma opinione. Ad esempio, su come commentare, si spera che il tuo linguaggio abbia delle convenzioni chiare come PEP 257 .

    
risposta data 21.11.2016 - 16:05
fonte

Leggi altre domande sui tag