opensafely / opensafely/documentation
Consolidate best practice documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
We have several issues and discussions that relate to documenting best practice:
- #688
- #627
- #594
- #252
- #46
- #45
- #801
- #795
Currently, best practice is located under OpenSAFELY best practice in the menu. However, this is a pick-and-mix: from the manifesto to a study design, via Git. There is also a section on Programming tricks, although this relates to study definitions; and we have the discussion/Q&A forum.
It would be good to address these issues and to consolidate best practice documentation.
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 by reviewing issues #688, #627, #594, #252, #46, #45, #801 and #795, then inspect the current “OpenSAFELY best practice” menu and the linked manifesto, Git workflow, case-control studies, study-definition tricks, and discussion pages. Done means producing an agreed, consolidated structure for best-practice documentation and updating the relevant navigation and content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100