cytomining / cytomining/copairs

Implement declarative `ruff` and `ruff format` linting

Open
#121 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
24
Forks
11
PR merge metrics
No merged PRs in 30d

Description

I noticed the project includes `ruff` as a dependency and also has a GitHub Action job which checks for formatting. CI without any local development automation can sometimes make for a confusing experience (especially without documentation). It also might be challenging when different versions of `ruff` are used.

A `pre-commit` configuration could be added to help make this expectation more declarative and available for developers to use. Anyone who doesn't want to modify their git flow could just manually run `pre-commit run -a` or whichever command makes sense (you don't have to use the git hook to see utility in the tool). The CI job could be modified to implement the exact same `pre-commit` check through `ruff` and `ruff format` to help make this seamless from development to pull request.

Contributor guide

Open the contributing guide

Research direction

Inspect the existing ruff dependency and the GitHub Action job that checks formatting first, then determine where the project's development and CI configuration should be updated. Done means developers can run the same declarative ruff and ruff format checks locally, while CI uses the matching check consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.