bobluppes / bobluppes/graaf

Add a SECURITY.md with a vulnerability disclosure policy

未关闭 适合新手
#321 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
C++
星标
413
派生
67
平均合并
7 小时 24 分钟
30 天内合并 PR
53

描述

## Summary

The repository has no `SECURITY.md` and no documented process for reporting a vulnerability.

## Current state

The repo root contains `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md`, but no `SECURITY.md`. GitHub's "Security" tab has no security policy configured, and there's no mention anywhere (README, CONTRIBUTING, wiki) of how a vulnerability should be reported, what response time to expect, or which versions receive fixes.

## Why this matters

Teams evaluating a dependency for use in a production environment routinely check for a published vulnerability-disclosure process as part of their due-diligence/vendor-review checklist. Without a `SECURITY.md`, there's no clear, private channel to report a potential issue (e.g. a memory-safety bug reachable from untrusted input in the DOT parser, or an algorithmic complexity issue that could be abused as a DoS vector) — reporters are left to use public issues, which is inappropriate for anything sensitive before a fix is available.

## Suggested resolution

- Add a `SECURITY.md` describing:
- Which versions/branches currently receive security fixes.
- A private reporting channel (e.g. GitHub's "Private vulnerability reporting" feature, or a maintainer email).
- Expected acknowledgement/response timelines.
- Enable GitHub's private vulnerability reporting for the repository.
- Link `SECURITY.md` from the README.

## Acceptance criteria

- [ ] `SECURITY.md` exists at the repo root and is picked up by GitHub's Security tab.
- [ ] A private reporting mechanism is enabled and documented.
- [ ] README links to the security policy.

贡献指南

打开贡献指南

调研方向

Look at the existing CODE_OF_CONDUCT.md and CONTRIBUTING.md files in the repository root for formatting. Use GitHub's documentation on creating a SECURITY.md file and enabling private vulnerability reporting. The new file should be placed in the repo root and linked from the README. Check the repository's Security tab after creation to confirm it is recognized.

由索引模型根据 Issue 内容生成。

评估

领域
documentation, security
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
活跃
描述清晰度
描述清楚
新手友好度
85/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。