Project-MONAI / Project-MONAI/model-zoo
Enable content in `CONTRIBUTING.md` be generated by code
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 338
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
Now in MONAI-core, required and optional properties of bundles are defined in:
https://github.com/Project-MONAI/MONAI/blob/9d6ccce3d46d64b3ffe289349f50323bd0a1b6eb/monai/bundle/properties.py
It would be easier to keep these content up-to-date with it.
Contributor guide
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 with CONTRIBUTING.md in the model-zoo repository and compare its required and optional bundle-property content with monai/bundle/properties.py at the linked MONAI revision. Determine how the documentation should be generated and define done as keeping the CONTRIBUTING.md content synchronized with those property definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100