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

Add SECURITY.md and enable secret scanning (missing on 3 of 4 OSE repos)

Đang mở
  • Có gì không ổn?
#382 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
50/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
github, markdown
Lĩnh vực
documentation, security

Hướng nghiên cứu

Start by reading the disclosure path in qBraid/qBraid's SECURITY.md, then add a SECURITY.md at the root of pyqasm, qbraid-qir and qbraid-algorithms, which currently have none. Each file should name a contact and a response expectation. Secret scanning and push protection are toggled under the repository's Settings, in the code security section. Done means all three repositories have a SECURITY.md and both settings are enabled where they were off.

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

Mô tả

Problem

Three of the four public OSE repositories have no SECURITY.md, so a researcher who finds a vulnerability in them has no documented private disclosure path. Their only options are a public issue, which discloses the problem to everyone at once, or guessing at an email address.

Repo SECURITY.md Secret scanning
qBraid ✅ ✅ enabled
pyqasm ❌ ❌ disabled
qbraid-qir ❌ ❌ disabled
qbraid-algorithms ❌ ❌ disabled

PyQASM is the sharpest case: it now records more monthly downloads than the qBraid-SDK, so it is the most-installed package in the ecosystem and the one with no way to report a vulnerability privately.

Suggested fix

  1. Add SECURITY.md to pyqasm, qbraid-qir and qbraid-algorithms, pointing at the same disclosure path qBraid/qBraid already uses. A short file naming a contact and a response expectation is enough.
  2. Enable secret scanning and push protection on the three repositories where they are off. Both are settings changes.
  3. Consider enabling private vulnerability reporting so reports arrive through GitHub rather than email.

Why now

Zero security advisories have been published across all four repositories in the project's history. That reflects no reported vulnerabilities rather than a process for handling them, and the first report is a bad time to discover the process does not exist.

Ngôn ngữ chính
Python
Star
29
Fork
33
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
15

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 qBraid/pyqasm

Tất cả issue của qBraid/pyqasm

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.