opensafely-core / opensafely-core/opensafely-cli
Add project validation command: `check`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 5
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 4
Description
Proposed name: opensafely check
This should run the project validation code from jobrunner. As we add further kinds of checks e.g. for codelists or study definitions it should run those too. Ideally it would be a one stop "is everything OK with my project command".
We might want to support warnings as well as outright errors. For example, having uncommitted changes should probably be a warning.
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 locating the existing project validation code in jobrunner and the opensafely-cli command entry points. Determine how a check command could run current and future project checks, including the proposed warning for uncommitted changes. Done should be defined as a clear validation result for the whole project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100