AllenInstitute / AllenInstitute/ConnectsCommonConnectivity
ClusterMembership: enforce merge keys in io, not schema
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem: item and cluster are Optional in the schema and there is no id; merge keys (#13) must be non-null at write time.
Fix: add item, cluster to required_for_write (as already done for hierarchy_id); schema stays Optional.
Convention (decided): the schema is the standard (eventually its own repo); this io package is one wrapper around it. Constraints required only by this write method belong in the io layer, not the schema. Apply wherever merge keys land (#12 etc.).
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
Locate ClusterMembership and the existing required_for_write handling, starting with the hierarchy_id convention. Add item and cluster wherever the merge keys are enforced in the io layer, apply the same rule to other merge-key locations such as #12, and leave the schema Optional.
Written by the indexing model from the issue text.
Assessment
- Domain
- data
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100