People-Places-Solutions/floodmodeller-api

Consolidate shared functionality between `IEF` and `XML2D`

Open

#146 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

There are some pieces of code that are identical between IEF and XML2D, for instance the _update_progress_bar method. These should be extracted into a shared function to avoid unnecessary duplication. Other methods like simulate might also have some partial duplication that should be dealt with.

Contributor guide

Research direction
Identify the duplicate methods (e.g., update progress bar) between IEF and XML2D classes and extract them into a shared function or base class.
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70