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

OSPS-DO-03.01 checks for a support file, but the requirement is release verification instructions

Đang mở
  • Có gì không ổn?
#511 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 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
48/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation, security

Hướng nghiên cứu

Start by reading the SupportDocumentation control in openssf-baseline.toml, then trace where that control is implemented and tested. Check how the project represents documentation checks and whether it can determine if a release exists. Done means the check assesses release-integrity instructions in project documentation, cannot pass on keywords alone, and is not assessed when there are no releases.

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

Mô tả

module-baseline

OSPS-DO-03.01 (Maturity Level 3) reads:

When the project has made a release, the project documentation MUST contain instructions to verify the integrity and authenticity of the release assets.

The control is named SupportDocumentation in openssf-baseline.toml and checks for a support file (file_exists) followed by a keyword regex for support|help|issue|question. Neither measures the requirement: a SUPPORT.md passes, and a project that documents signature or checksum verification in its README or release notes does not.

Suggested direction:

  • rename the control and replace the steps with ones aimed at the requirement (look for verification instructions in the README, release docs, or SECURITY.md: cosign/gpg/sha256sum/slsa-verifier usage);
  • keep any keyword step unable to conclude PASS; the final say belongs to a judgment of the documentation content;
  • the requirement is conditional on a release existing, so the control should be N/A (or not assessed) when there are no releases.

Related: #508 (another control whose check does not match its requirement).

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

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

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 darnitdevorg/darnit

Tất cả issue của darnitdevorg/darnit

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.