PAIR-code / PAIR-code/deliberate-lab
CI: GitHub Action to validate typed Python on pull requests
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 96
- Forks
- 40
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 20
Description
Currently, we have a GitHub Action (ci.yaml) which checks formatting and runs tests for every incoming pull request.
The scripts/ subdirectory contains typed Python command line client for Deliberate Lab. We should enhance the pull request GitHub Action to assert that the Python files' types are correct in addition to other checks.
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 with .github/workflows/ci.yaml and inspect the typed Python command-line client under scripts/. Extend the pull-request workflow with a type validation check alongside formatting and tests; it is done when correctly typed Python passes and type errors cause the action to fail.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100