realpython / realpython/materials
Clarify Ruff installation requirement before running lint commands
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5.2k
- Forks
- 5.3k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 10
Description
Hi 👋,
In the "Running Code Style Checks" section of the README, contributors are instructed to run:
However, it may not be immediately clear to new contributors that Ruff needs to be installed first.
Would it be helpful to briefly mention how to install Ruff (for example via pip or from requirements.txt) before running these commands?
Happy to open a PR with a suggested clarification if this sounds reasonable.
Thanks!
Contributor guide
No contributing guide indexed for this repository
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
Open the README and find the “Running Code Style Checks” section. Check the existing Ruff commands, then add a brief installation prerequisite before them using the project’s documented dependency path. Done when a new contributor can install Ruff and follow the lint instructions without guessing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100