StackGuardian / StackGuardian/tirith
chore: adopt ruff for linting, formatting and import sorting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
The project currently uses black (pyproject.toml's [tool.black], black in the Pipfile) and
has no lint or import-sorting step. Ruff covers all three in one
fast tool: ruff check for linting (including isort-style import sorting via the I rules) and
ruff format as a black-compatible formatter.
Tasks
- Add ruff configuration in
pyproject.toml: the default rule set plusI(import sorting), with
target-versionmatching the supported Python floor. - Run
ruff check --fixandruff format; keep the mechanical changes in their own commit,
separate from any manual fixes they surface. - Replace black with ruff in the
Pipfile/dev tooling, and add a CI step under
.github/workflows/runningruff checkandruff format --check. - Update
CONTRIBUTING.mdwith the new commands.
This also covers import sorting, which was previously tracked as its own issue.
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 by reading the existing [tool.black] configuration in pyproject.toml, the Pipfile, .github/workflows/, and CONTRIBUTING.md. Run the requested ruff check --fix and ruff format commands, keeping their mechanical changes separate from manual fixes. Done means Ruff replaces Black, CI runs both checks, and the contributor commands are updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100