跳至主要内容

向您的项目添加支持资源

您可以创建一个 SUPPORT 文件,让人们了解获取项目帮助的方式。

要将人们引导至具体的支持资源,您可以在仓库的根目录、docs.github 文件夹中添加一个 SUPPORT 文件。当有人在您的仓库中创建 Issue 时,他们会看到指向您项目 SUPPORT 文件的链接。

Screenshot of the new issue form. In the right sidebar, in the "Helpful resources" section, a link labeled "Support" is outlined in dark orange.

您可以为您的组织或个人账户创建默认的支持资源。欲了解更多信息,请参阅 创建默认社区健康文件

提示

为了帮助人们找到您的支持指南,您可以在仓库的其他位置(例如您的 README 文件)中链接到您的 SUPPORT 文件。

向您的项目添加支持资源

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

  2. 在文件列表上方,选择 添加文件下拉菜单,然后点击 创建新文件

    或者,您可以点击在左侧的文件树视图中。

    Screenshot of the main page of a repository highlighting both the "Add file" and the "plus sign" icon, described above, with an orange outline.

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

  4. 编辑新文件 选项卡中,添加有关人们如何获取项目支持的信息。

  5. 要预览您的 SUPPORT 文件,请点击 预览

  6. 点击 提交更改...

  7. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  8. 如果您的 GitHub 账户关联了多个电子邮件地址,请点击电子邮件地址下拉菜单并选择要用作 Git 作者电子邮件地址的邮箱。仅已验证的电子邮件地址会出现在此下拉菜单中。如果您启用了电子邮件地址隐私,则默认的提交作者电子邮件地址将是 “no‑reply”。有关 no‑reply 邮箱的具体形式,请参阅 设置提交电子邮件地址

    Screenshot of a GitHub pull request showing a dropdown menu with options to choose the commit author email address. octocat@github.com is selected.

  9. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  10. 点击 提交更改提议更改

© . This site is unofficial and not affiliated with GitHub, Inc.