PankratzLab / PankratzLab/DonorCheck
Validation Model API Refinements
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
- Split "assigned types" and "haplotypes" to defined components instead of lumping them all together in one class
- Document the
Buildermethods to better explain what should be passed as input
Contributor guide
No contributing guide indexed for this repository
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 the validation model and the Builder methods referenced in the issue, then review how assigned types and haplotypes are currently represented together. Separate those concepts into defined components and document the Builder inputs. Done means the model no longer lumps the types together and the Builder API explains its expected inputs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100