Duzzuti/passwd-manager

[NTH] Ensure code quality

Offen

#18 geöffnet am 01.06.2023

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C++ (4 Forks)auto 404
enhancementgood first issue

Repository-Metriken

Stars
 (9 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfe jede Funktion im Codebase, ob die Namen zum Verhalten passen und die Funktionen nur eine Sache tun. Falls nicht, umbenennen oder aufteilen.
Tech Stack
c
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75