NatLabRockies / NatLabRockies/H2Integrate

Refactor H2IntegrateModel and split it out; especially checking

Open
#883 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
26
Forks
44
Avg merge
3d 22h
Merged PRs (30d)
16

Description

Refactor H2IntegrateModel and split it out; especially checking

H2IntegrateModel has ballooned to be quite large.
I would be a fool if I didn't acknowledge my role in that.

Proposed solution

However, change is possible, and I think starting by moving a lot of the checking methods out of the class itself and into functions that are imported and used would be a nice starting point.
Along the way, we can identify and shift other methods as well or make corresponding issues.

Alternatives considered

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating H2IntegrateModel and inventorying its checking methods and related methods. Extract the checking logic into imported functions while preserving current behavior; done when the class is smaller and its checks still work through the new functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.