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

docs: distinguish contributor test prerequisites from minimal runtime dependencies

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,239 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/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ệ
bash, c, git, python
Lĩnh vực
build-system, documentation, testing

Hướng nghiên cứu

Cập nhật CONTRIBUTING.md sau khi kiểm tra các lệnh và điều kiện tiên quyết trong tests/run_all_tests.sh, tools/werror_switch_check.sh, hướng dẫn CI và .devcontainer được liên kết. Tách các dependency runtime tối thiểu khỏi các công cụ build/test dành cho contributor, bao gồm các yêu cầu đối với Git checkout và tiện ích SHA-256, đồng thời giữ nguyên các lệnh và hành vi của test.

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

Mô tả

area:docs documentation good first issue help wanted kind:docs-drift

The Getting Started section of CONTRIBUTING.md instructs contributors to build and run the full test suite, then says it requires only gcc. That describes the minimal runtime build incompletely and does not describe the contributor test environment.

Evidence and starting points

Checked at b91768e23c5a874a64e76e4af9ab291e6aa49983:

  • CONTRIBUTING.md:7–14 puts the build and full-suite commands directly before the gcc-only claim.
  • tests/run_all_tests.sh invokes make to build test fixtures (for example lines 618, 645, and 725).
  • The sanitizer-classifier section explicitly makes missing Python 3 or Git checkout coverage fatal.
  • .devcontainer/ already provides a prepared contributor environment and is linked in the root README.

This is source-confirmed; no full suite was run with tools removed from the machine.

First-contribution scope

Correct the Getting Started requirements, distinguishing the minimal runtime's lack of third-party library dependencies from the tools used to build and test it. Name Bash, the C build toolchain, Make, Python 3, Git, and standard Unix shell/build utilities as contributor prerequisites. In particular, the suite requires a SHA-256 utility (sha256sum or shasum; see tools/werror_switch_check.sh). Explain that the suite runs from a Git checkout, and link the existing devcontainer as a prepared option. Check the current suite and CI instructions for any further required tools before presenting a complete list.

Keep the change in the contribution guide; this issue does not ask for a new installer, environment redesign, or weaker tests. Basic Markdown and command-line familiarity are sufficient.

Done when

  • A new contributor can distinguish runtime dependencies from build/test tools.
  • The listed prerequisites agree with the actual build and suite commands.
  • The guide explains the Git checkout requirement and links the prepared environment.
  • Build/test commands and test behavior remain unchanged.

PR #1226 touches the issue-labelling section of the same document, but does not address these Getting Started requirements; rebase if it lands first.

Ngôn ngữ chính
C
Star
3
Fork
7
Merge trung bình
3 giờ 58 phút
Pull request đã merge (30 ngày)
105

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 InauguralSystems/EigenScript

Tất cả issue của InauguralSystems/EigenScript

Issue tương tự

Thêm issue về C

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.