Duzzuti/passwd-manager

[NTH] Ensure code quality

Aperta

#18 aperta il 1 giu 2023

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)C++ (4 fork)auto 404
enhancementgood first issue

Metriche repository

Star
 (9 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

We should ensure that functions should have two properties:

  1. The name is relevant for what they do
  2. The function does one single thing.

Specially if we notice that property number 2 isn't fulfilled we should split the function into as many different things is doing. Following this idea makes the code much easier to read and debug.

  • Difficulty (1-10): 2

Guida contributor

Direzione di ricerca
Esamina ogni funzione nel codebase, verifica che i nomi corrispondano al comportamento e che le funzioni facciano una sola cosa. Se non corrispondono, rinomina o dividi.
Tech stack
c
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitC++
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75