renalreg/ukrdc-cupid

Refactor xml types

Open

#24 opened on Mar 22, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (0 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

Currently many of the types used in the schema (such as common meta data, clinician etc) are hardcoded in the models. They should be separated out into reusable functions. In some places the reusable functions have been written such as address and code but they are either not very modular or are just randomly scattered around the shop.

They should really live all together in their own little file and be imported where they are needed. I have made a placeholder for this but not got much further than that. Not only will this make everything cleaner it will make implementing future changes to the schema much less painful.

Edit: In general the models should be refactored to better reflect the structure and inheritance pattern of the schema.

Contributor guide

Research direction
Identify all hardcoded types in models (e.g., common metadata, clinician). Study existing reusable functions like address and code for pattern. Create a new file for these functions and import them into models. Ensure inheritance patterns are respected.
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-2 days
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
PythonXML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60