HIPS/autograd

Add a workflow to run style checks in CI

Open

#637 opened on Aug 30, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (6,628 stars) (909 forks)batch import
PR welcomegood first issue

Description

After #634, we can add a style check job in CI to complement https://pre-commit.ci and the pre-commit hooks we have, running on PRs.

Contributor guide

Tech stack
pythongithub actions
Domain
ci cddevops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Read issue #634GitHub Actions basicspre commit knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
First, review issue #634 to understand the context and the existing pre commit hooks. Then, examine the current CI workflows in the .github/workflows/ directory to see the structure and naming patterns. Create a new workflow file that runs style checks (e.g., flake8 or black) on PRs, ensuring it complements the pre commit.ci integration. The workflow should be triggered on pull requests and should run the same checks as the pre commit hooks.