Checklist per lo Sviluppo

L'obiettivo della seguente checklist è garantire che tutte le attività di sviluppo siano documentate, revisionate e testate correttamente, mantenendo un elevato standard di qualità e chiarezza durante tutto il progetto.

Linee Guida per lo Sviluppo

• Controllo di Versione:
  • Assicurati che tutte le modifiche siano caricate sul branch appropriato seguendo la strategia di branching.
  • Esegui commit regolari e utilizza messaggi descrittivi.
  • Se si tratta di una modifica alla UI o di uno script nuovo, aggiorna la pagina release con il branch UI da deployare o lo script da eseguire per ogni ambiente.
• Documentazione delle Integrazioni API in Confluence:
  • Fornisci una descrizione dettagliata di qualsiasi integrazione con servizi web o eventi Kafka (vedi sezione Documentazione Obbligatoria).
  • Includi esempi di payload di richiesta e risposta (vedi sezione Documentazione Obbligatoria).
  • Documenta eventuali callback, se presenti (vedi sezione Documentazione Obbligatoria).
  • Fornisci un esempio di eventi inviati o ricevuti, specificandone struttura e contenuto (vedi sezione Documentazione Obbligatoria).

Code Review

• Invio del Codice per la Revisione:
  • Assicurati che tutte le funzionalità implementate e le correzioni siano inviate tramite lo strumento di code review del progetto.
• Checklist per la Revisione:
  • Verifica l’efficienza, le prestazioni e la leggibilità del codice.
  • Assicurati che il codice sia sicuro e privo di vulnerabilità.
  • Controlla che ci sia copertura di test adeguata (unit test, integration test, ecc.) e che non si aspetti che i tester trovino bug :)
  • Verifica che tutta la documentazione necessaria sia stata creata o aggiornata in Confluence.
• Implementazione dei Feedback:
  • Affronta tutti i commenti ricevuti durante la revisione del codice.
  • Apporta le modifiche necessarie e aggiorna il codice di conseguenza.
  • Rinvia il codice per ulteriore revisione, se necessario.

Testing e Validazione

• Unit Testing:
  • Crea unit test per tutte le nuove funzioni o classi implementate.
  • Assicurati che tutti gli unit test vengano superati prima di considerare completato il task.
• Integration Testing:
  • Sviluppa test di integrazione per qualsiasi nuova integrazione (API, servizi, eventi Kafka).
  • Conferma che l’integrazione funzioni come previsto negli ambienti di test.
• End-to-End Testing:
  • Esegui test end-to-end per validare il flusso completo e le interazioni utente.
  • Assicurati che tutti i test siano superati senza errori o problemi.

Documentazione Obbligatoria in Confluence

• Integrazione API/Servizi Web:
  • Includi un esempio dettagliato di una richiesta (formato JSON o XML) e la corrispondente risposta.
  • Fornisci un esempio di eventuale callback, se applicabile.
  • Documenta la struttura e il contenuto di qualsiasi evento Kafka inviato o ricevuto, inclusi header e payload.
• Diagrammi:
  • Sequence Diagram: Crea almeno un diagramma di sequenza per mostrare il flusso di interazione tra i vari componenti o servizi per ogni user story.
  • Architectural Diagram: Elabora un diagramma architetturale per mostrare la struttura del sistema e come le nuove funzionalità si integrano nell’architettura esistente.