canonical / canonical/charmlibs

Commit ruff format and ruff check --fix results separately in migration guide

Open Beginner friendly
#595 0 comments 1 reaction 0 assignees View on GitHub
docs infra rainy day team-charmlibs-maintainers
Dominant language
Python
Stars
5
Forks
28
Avg merge
1d 5h
Merged PRs (30d)
24

Description

@dwilding observed in #588 that it's handy to commit the `ruff format` results before diving into the deeper issues that `ruff check --fix` handles. Rather than advise running the underlying commands in the migration guide, let's add a `--no-fix` flag to `just format` which skips running `ruff check --fix`, and advise using that.

Contributor guide

Open the contributing guide

Research direction

Start with the `just format` entry point and the migration guide mentioned in the issue. Check how `ruff format` and `ruff check --fix` are currently invoked, then verify that `--no-fix` skips only the latter and that the guide recommends it for separate commits.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.