opensafely / opensafely/documentation
Add tips on structuring your pipeline
Open
Nobody has claimed this yet.
new content
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
In particular,
- ensure you pull out repetitive bits into their own actions
- change expensive long-running loops so they can be run as individual actions with different parameters
The former saves you time by allowing you to use previously-computed outputs for dependent actions.
The latter gives you easy parallelisation for your loops
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
No file or test is named; first locate the documentation section covering pipeline structure. Add tips covering reusable actions for repetitive steps and parameterized individual actions for expensive loops, including the stated benefits of reuse and parallelization.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100