opensafely-core / opensafely-core/opencodelists
Definition builder: Documentation notes feature
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 16
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 17
Description
For search terms and even specific codes it would be good if you could add a note to support rationale.
Sometimes when including /excluding a code it might not be apparent to the reviewer or your future self why you included or excluded something. It would be good to document rationale.
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 definition builder and tracing how search terms and codes are represented and saved. The issue names no files or tests, so inspect the builder entry point and existing tests first. Done should mean rationale notes can be attached to included or excluded terms and are preserved for reviewers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100