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

Refresh README for first-time visitors and setup

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#88 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 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
76/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với README, so sánh các yêu cầu và hướng dẫn thiết lập trong đó với requirements.txt, rồi xem doc/EXAMPLES.md được liên kết để tìm các bản demo tiêu biểu. Cập nhật nội dung trang đích, badge, các cách thiết lập, yêu cầu và hướng dẫn dành cho người đóng góp như mô tả. Hoàn tất khi README bao quát các điểm này và phần pyright được chuyển sang HOWTOCONTRIBUTE.md.

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

Mô tả

documentation enhancement

Problem

The README is the landing page for most visitors (from LinkedIn and GitHub), but:

  • The first screen has one GIF (NDT mapping) and a generic description. It doesn't show what you can learn.
  • The CI badges point to the old repository name AutonomousDrivingSamplePrograms (https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide/blob/main/README.md#L2).
  • Setup only describes VS Code Dev Container. There is no pip install -r requirements.txt path, and Docker on WSL/macOS needs X11 forwarding, which isn't mentioned.
  • Requirements in the README (Python, Matplotlib, NumPy, SciPy) don't match requirements.txt (casadi and do-mpc for MPC are missing).
  • A 27-line section about pyright/sys.path settings is for contributors, not learners.
  • Running tests on Windows (run_test_suites.bat) is not mentioned. Typo: "thi repo".

Expected fix

  • First screen: a grid of representative demo GIFs, a one-line summary of what you can learn, and a link to doc/EXAMPLES.md
  • Fix the badges
  • Add a simple pip-based setup next to the Dev Container one, and note the X11 requirement
  • Align the requirements list with requirements.txt
  • Move the pyright section to HOWTOCONTRIBUTE.md
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.