ga4gh / ga4gh/phenopacket-schema

Update the Phenopackets Documentation

Open
#446 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
101
Forks
34
PR merge metrics
No merged PRs in 30d

Description

Provide more values for the documentation for MoleculeContext https://github.com/ga4gh/phenopacket-schema/issues/334
Add details to the documentation about the MedicalAction field. https://github.com/ga4gh/phenopacket-schema/issues/347
Avoid the term 'germline sample' outside the context of cancer https://github.com/ga4gh/phenopacket-schema/issues/325
One-sided ReferenceRange: remove permissions to include invalid numbers such as NaNs and infinities. https://github.com/ga4gh/phenopacket-schema/issues/343
Serialize numbers as a string. https://github.com/ga4gh/phenopacket-schema/issues/340
Update/add (?) Requirements on version strings in documentation https://github.com/ga4gh/phenopacket-schema/issues/288

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the six linked issues and locating the documentation covering MoleculeContext, MedicalAction, germline samples, ReferenceRange, number serialization, and version strings. Done means each requested documentation or requirement update is addressed and the affected documentation is internally consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.