opensafely-core / opensafely-core/sqlrunner
Update README
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- Avg merge
- 4d 23h
- Merged PRs (30d)
- 3
Description
The README would benefit from information about how to use SQL Runner, as well as the situations when SQL should be used.
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 by reading the README and the existing SQL Runner usage information. Update the README to explain how to use SQL Runner and when SQL should be used; the documentation is done when both topics are clearly covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100