nasa / nasa/python_cmr

Use ruff for linting

Open
#87 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore
Dominant language
Python
Stars
29
Forks
32
Avg merge
19h 6m
Merged PRs (30d)
1

Description

We currently use flake8 for linting, but ruff provides a nice way to consolidate linting rules used/defined by various other tools, such as black and flake8. We should also remove the "special" linting cases currently run only as part of CI (see .github/workflows/python-app.yml). Linting should be applied the same way, whether we're contributing code or running CI.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading .github/workflows/python-app.yml and identify the current flake8 and special linting steps. Trace how linting is run for contributors and in CI, then consolidate those paths around ruff. Done means the special CI-only cases are removed and linting behaves the same locally and in CI.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.