People-Places-Solutions/floodmodeller-api

Consolidate duplications within structure log

Open

#149 opened on Jan 7, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (23 forks)auto 404
good first issuerefactor

Repository metrics

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

Description

In structure_log.py, there is a lot of duplication between add_conduits and add_structures. This should be extracted into a common function.

Contributor guide

Research direction
Analyze the duplicated code in structure log.py, identify similarities between add conduits and add structures, and extract a common helper function.
Tech stack
python
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75