Skip to main content

将安全策略添加到存储库

您可以为仓库添加安全政策,说明如何报告项目中的安全漏洞。

关于安全政策

要向人们提供报告项目中安全漏洞的说明,可以将 SECURITY.md 文件添加到存储库的根目录、docs.github 文件夹。当有人在你的存储库中创建问题时,他们将会看到一个指向你的项目的安全策略的链接。

你可以为组织或个人帐户创建默认的安全政策。 有关详细信息,请参阅创建默认社区运行状况文件

提示:为帮助人们查找安全策略,可以从存储库中的其他位置(如 README 文件)链接到 SECURITY.md 文件。 有关详细信息,请参阅“关于 README”。

当有人报告项目中的安全漏洞后,可以使用 GitHub Security Advisories 披露、修复和发布关于该漏洞的信息。 有关 GitHub 中报告和披露漏洞的过程的详细信息,请参阅“关于安全漏洞的协调披露”。 有关 GitHub Security Advisories 的详细信息,请参阅“关于 GitHub Security Advisories”。

还可加入 GitHub Security Lab,以浏览与安全相关的主题,并为安全工具和项目做出贡献。

将安全策略添加到存储库

  1. 在 GitHub.com 上,导航到存储库的主页。 1. 在存储库名称下,单击“安全性”。 “安全”选项卡
  2. 在左边栏中,单击“安全策略”。 “安全策略”选项卡
  3. 单击“开始设置”。 “开始设置”按钮
  4. 在新的 SECURITY.md 文件中,添加关于项目受支持版本以及如何报告漏洞的信息。
  5. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息
  6. 如果在 GitHub.com 上有多个电子邮件地址与你的帐户关联,请单击电子邮件地址下拉菜单,然后选择要用作 Git 作者电子邮件地址的电子邮件地址。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果启用了电子邮件地址隐私,则 <username>@users.noreply.github.com 是默认提交作者的电子邮件地址。 有关详细信息,请参阅“设置提交电子邮件地址”。 选择提交电子邮件地址 1. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 1. 单击“提议文件更改”。 提议文件更改按钮

延伸阅读