Duzzuti/passwd-manager

[NTH] Ensure code quality

Open

#18 opened on Jun 1, 2023

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)C++ (4 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Review each function in the codebase, check if names match behavior and if functions do one thing. If not, rename or split accordingly.
Tech stack
c
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75