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

Document and clean up VehicleSpecification

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#129 1 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 9 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
autonomous-driving, documentation

Hướng nghiên cứu

Bắt đầu với src/components/vehicle/vehicle_specification.py và kiểm tra các đối số của VehicleSpecification cùng những phép tính kích thước được suy ra. Ghi lại đơn vị của từng đối số, làm rõ các hằng số chưa được giải thích hoặc biến chúng thành tham số, dùng None làm giá trị mặc định cho các giới hạn có thể thay đổi và đổi tên area_size để bao gồm đơn vị. Công việc hoàn tất khi các đơn vị và giá trị mặc định được ghi lại khớp với phần triển khai, đồng thời các thực thể riêng biệt không dùng chung những đối tượng giới hạn có thể thay đổi.

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

Mô tả

good first issue refactoring

Problem

In src/components/vehicle/vehicle_specification.py:

  • Derived sizes use unexplained constants: f_edge_m = f_len_m + 0.5, tread_m = 0.25 * (1.0 + f_len_m + r_len_m), width_m = 1.0 * tread_m
  • x_lim=MinMax(-30, 30) and y_lim=MinMax(-30, 30) are default arguments evaluated once, so all instances share the same objects
  • area_size has no unit in its name, and axle_half_m is not documented

Expected fix

Name and explain the constants (or make them parameters with documented defaults), use None defaults for mutable arguments, rename area_size with a unit suffix, and document every argument with its unit.

Ngôn ngữ chính
Python
Star
1.9k
Fork
313
Merge trung bình
9 ngày 10 giờ
Pull request đã merge (30 ngày)
7

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.

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 ShisatoYano/AutonomousVehicleControlBeginnersGuide

Tất cả issue của ShisatoYano/AutonomousVehicleControlBeginnersGuide

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.