我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们。

将支持资源添加到项目

您可以创建 SUPPORT 文件,让人们知道获取项目相关帮助的方式。

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

要将人们定向到特定的支持资源,您可以将 SUPPORT 文件添加到仓库的根文件夹 docs 或 .github。 当有人在您的仓库中创建议题时,就会看到项目 SUPPORT 文件的链接。

支持指南

You can create default support resources for your organization or user account. 更多信息请参阅“创建默认社区健康文件”。

提示:为帮助人们查找您的支持指南,您可以从仓库其他位置(如自述文件)链接到 SUPPORT 文件。

将支持资源添加到项目

  1. 在 GitHub 上,导航到仓库的主页面。

  2. 在文件列表上方,使用 Add file(添加文件)下拉菜单,单击 Create new file(创建新文件)。

    "添加文件"下拉菜单中的"创建新文件"按钮

  3. 在文件名字段中,输入 SUPPORT.md(全大写)。

  4. 在 Edit new file(编辑新文件)选项卡中,添加人们如何获取项目支持的信息。

  5. 要查阅 SUPPORT 文件,请单击 Preview(预览)。

  6. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。

    有关更改的提交消息

  7. 以下是提交消息字段,请单击电子邮件地址下拉菜单并选择 Git 作者电子邮件地址。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果您启用了电子邮件地址隐私保护,则 <username>@users.noreply.github.com 为默认的提交作者电子邮件地址。 更多信息请参阅“设置提交电子邮件地址”。

    选择提交电子邮件地址

  8. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 更多信息请参阅“创建新的拉取请求”。

    提交分支选项

  9. 单击 Propose new file(提议新文件)。

    提议新文件按钮

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。