The-Strategy-Unit / The-Strategy-Unit/nhp_model
Enrich documentation for model users
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 3
- Avg merge
- 21h 39m
- Merged PRs (30d)
- 10
Description
In order to
a) make it easier for a non-NHP model expert to get up and running with the model,
b) for new model devs to find their way through and maintain the code more easily (better bus factor),
it'd be useful to expand the README documentation with more detailed information on model setup, model usage, most important modules to look out for, idiosyncrasies we should be aware of and so on.
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 with the README and review the existing model setup and usage guidance. Map the most important modules and record project-specific idiosyncrasies that a non-NHP expert or new model developer would need. Done means the documentation clearly covers setup, usage, module navigation, maintenance context, and relevant caveats.
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