zzos/Python
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/Python.git synced 2026-09-28 21:45:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(skill): recommend ruff --fix workflow for PRs failing ruff check (#15218)

Browse Source 
* docs(skill): recommend ruff --fix then --unsafe-fixes for PRs failing ruff check

* Update .github/skills/code-review/SKILL.md

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
This commit is contained in:
priya-sundaram-dev
2026-09-07 07:48:43 +02:00
committed by GitHub
co-authored by Christian Clauss
parent ece9b395b8
commit ca133c7b2c
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/skills/code-review/SKILL.md
+18
View File
@@ -33,6 +33,24 @@ suggest the fix — never just "rejected".
- [ ] Descriptive variable and function names (no single letters where a word helps).
- [ ] Code is formatted and lint-clean (`ruff`, `pre-commit`).
#### When a PR fails `ruff check`
Don't just report the failure — try the mechanical fixes and recommend the one
that works, in this order:
1. Run `ruff check --fix file_path.py`. If that makes the file pass, recommend
that solution — these are the fixes `ruff` considers **safe**.
2. If it still fails, run `ruff check --fix --unsafe-fixes file_path.py`. If that
makes the file pass **and** the resulting diff is genuinely safe (it preserves
behavior — review it, don't trust it blindly), recommend that solution and note
that it required `--unsafe-fixes`.
3. If neither passes, or the unsafe fix would change behavior, describe the
remaining rule violations and the manual change the author needs to make.
Always quote the exact rule code(s) `ruff` reports (e.g., `ruff rule UP047`,
`ruff rule RUF100`) so the author can run those commands to read the rules being
flagged. Also, paste the concrete command you ran.
### 3. Other Requirements for Submissions
- [ ] At least one **Wikipedia (or equivalent) URL** documenting the algorithm.