NatLabRockies / NatLabRockies/H2Integrate
Break apart methods in H2IntegrateModel where useful
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Break apart methods in H2IntegrateModel where useful
Proposed solution
When we first created H2I, there were relatively few methods in H2IntegrateModel and they were smaller and less complex than they are now.
As we think through system-level control, we're expecting to expand out a lot of the framework to include more logic, connections, and handling.
We should break apart some of these methods into smaller, discrete methods where possible to make code maintenance and understandability better.
Alternatives considered
Having big ole methods. It's fine, but maybe tougher for new-to-the-code folks to track what's going on.
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating H2IntegrateModel and reading its methods to identify which are large or difficult to follow. Review existing tests around the model before deciding on boundaries; done means selected methods are split into smaller discrete units while behavior remains unchanged and the relevant tests still pass.
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