opensafely / opensafely/documentation

Write a protocol for L4 reviewer/publishers

Open
#59 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new content
Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

This is TBC and will require lots of discussion. @amirmehrkar is currently researching best practice in other TREs.

At a minimum this should be a checklist + guidance. Longer term it could perhaps be supported by tooling (online workflow/forms, scripts for verifying things, etc)

Lots of useful discussion in https://github.com/opensafely/cohort-extractor/issues/71

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the discussion in cohort-extractor issue 71 and the best-practice research that @amirmehrkar is undertaking. The issue names no documentation file or test; the work is complete when the agreed L4 reviewer/publisher protocol is documented as a checklist and guidance.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.