Clarify Ruff installation requirement before running lint commands

未关闭
#738 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

打开 README,找到“Running Code Style Checks”部分。检查现有的 Ruff 命令,然后在这些命令之前,使用项目文档中说明的依赖路径添加一条简短的安装前置条件。完成标准是:新贡献者无需猜测即可安装 Ruff 并按照 lint 说明操作。

由索引模型根据 Issue 内容生成。

描述

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!

主要语言
Jupyter Notebook
星标
5.2k
派生
5.3k
平均合并
4 天 10 小时
30 天内合并 PR
10

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

realpython/materials 的其他 Issue

查看 realpython/materials 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。