Clarify Ruff installation requirement before running lint commands

Đang mở
#738 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Mở README và tìm phần “Running Code Style Checks”. Kiểm tra các lệnh Ruff hiện có, sau đó thêm một điều kiện tiên quyết cài đặt ngắn gọn trước các lệnh đó bằng cách sử dụng đường dẫn dependency được tài liệu hóa của project. Hoàn thành khi một contributor mới có thể cài đặt Ruff và làm theo hướng dẫn lint mà không phải đoán.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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!

Ngôn ngữ chính
Jupyter Notebook
Star
5.2k
Fork
5.3k
Merge trung bình
4 ngày 10 giờ
Pull request đã merge (30 ngày)
10

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của realpython/materials

Tất cả issue của realpython/materials

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.