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]: Add an Example of Validating SBOMs

Đang mở
#708 2 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.

  • #5 của @saquibsaifee — đã đóng, không merge
  • #869 của @saquibsaifee — đã đóng, không merge

Đá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
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc tìm tài liệu hiện có cùng với JsonStrictValidator và các lớp validation liên quan trong thư viện Python. Thêm phần tổng quan về validation SBOM dựa trên schema và các ví dụ mã, bao gồm validation độc lập với serialization. Công việc được xem là hoàn tất khi người dùng có thể làm theo tài liệu để validation một SBOM bằng các lớp liên quan.

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

Mô tả

documentation help wanted

Create documentation to guide users on validating SBOMs.

The CycloneDX Python library can validate an SBOM based on the schema, independent of the library's support for SBOM serialization, which is a valuable feature. However, the current documentation lacks clear examples and instructions on effectively utilizing this validation functionality.

The following points should be addressed in the documentation:

An overview of how to validate SBOMs based on schema specifications.
Examples demonstrating the validation process, including code snippets using JsonStrictValidator and other relevant classes.

Ngôn ngữ chính
Python
Star
117
Fork
67
Merge trung bình
21 giờ 9 phút
Pull request đã merge (30 ngày)
3

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 CycloneDX/cyclonedx-python-lib

Tất cả issue của CycloneDX/cyclonedx-python-lib

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.