Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

chore: adopt ruff for linting, formatting and import sorting

Đang mở
  • Có gì không ổn?
#367 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
64/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
ci-cd, documentation, tooling

Hướng nghiên cứu

Bắt đầu bằng cách đọc cấu hình [tool.black] hiện có trong pyproject.toml, Pipfile, .github/workflows/ và CONTRIBUTING.md. Chạy các lệnh ruff check --fix và ruff format được yêu cầu, giữ riêng các thay đổi mang tính cơ học của chúng với các bản sửa thủ công. Công việc được xem là hoàn tất khi Ruff thay thế Black, CI chạy cả hai bước kiểm tra và các lệnh dành cho người đóng góp được cập nhật.

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

Mô tả

enhancement good first issue

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 plus I (import sorting), with
    target-version matching the supported Python floor.
  • Run ruff check --fix and ruff 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/ running ruff check and ruff format --check.
  • Update CONTRIBUTING.md with the new commands.

This also covers import sorting, which was previously tracked as its own issue.

Ngôn ngữ chính
Python
Star
176
Fork
54
Merge trung bình
1 ngày 20 giờ
Pull request đã merge (30 ngày)
9

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 StackGuardian/tirith

Tất cả issue của StackGuardian/tirith

Issue tương tự

Thêm issue về Python

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.