Template per Guida di Stile del Codice in Word
Allinea il team su uno standard di codice condiviso: una guida di stile completa con convenzioni, esempi corretti e sbagliati affiancati, regole di review e checklist, pronta in Word.
Esempio di output
# Guida di stile del codice — [linguaggio/stack] ## 1. Principi - Leggibilità prima di brillantezza - Coerenza con la codebase esistente prima delle preferenze personali ## 2. Naming | Elemento | Convenzione | Esempio | |---|---|---| | Variabili | camelCase, descrittive | userCount | | Costanti | UPPER_SNAKE | MAX_RETRIES | | Funzioni | verbo + oggetto | fetchInvoices() | ### DO / DON'T DO: ``` const activeUsers = users.filter(u => u.isActive); ``` DON'T: ``` const a = users.filter(u => u.x); // nomi opachi ``` Perché: i nomi opachi costringono a leggere l'implementazione per capire l'intento. ## 3. Struttura dei file - Un componente per file; export nominati preferiti agli export default. ## 4. Gestione degli errori | Regola | Automatizzabile dal linter | |---|---| | Mai catturare errori in silenzio | Parziale | | Errori tipizzati, non stringhe | Sì | ## 5. Test - Nome test: 'descrive comportamento, non implementazione' - Copertura minima per modulo critico: [valore da decidere col team] ## 6. Checklist di code review - [ ] Nomi chiari e coerenti - [ ] Nessun TODO senza ticket - [ ] Test per il nuovo comportamento - [ ] Gestione errori esplicita
Domande frequenti
Sì. Indichi linguaggio, framework e linter già in uso, e il prompt genera convenzioni concrete e idiomatiche per quello stack, non regole generiche. Gli esempi DO/DON'T sono scritti nella sintassi del tuo linguaggio.
Sì, ogni regola importante ha una coppia DO/DON'T affiancata con una breve spiegazione del perché. Sono il cuore della guida: rendono le convenzioni inequivocabili e riducono le discussioni soggettive in code review.
Sì. La guida marca quali regole sono automatizzabili dal linter/formatter e quali richiedono giudizio umano in review, così sai cosa puoi far rispettare in CI e cosa resta responsabilità del reviewer.
Vuoi un template su misura?
Costruiscine uno in poche domande — con la struttura corretta per il tuo standard.