Skip to main content

将支持资源添加到项目

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

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

新议题表单的屏幕截图。 在右侧边栏的“有用资源”部分中,标有“支持”的链接以深橙色框出。

可以为组织或个人帐户创建默认支持资源。 有关详细信息,请参阅“创建默认的社区运行状况文件”。

提示:为帮助用户查找支持指南,可以从存储库的其他位置(如 README 文件)链接到 SUPPORT 文件。

将支持资源添加到项目

  1. 在 GitHub.com 上,导航到存储库的主页。

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

    也可在左侧的文件树状视图中单击

    存储库主页的屏幕截图。 在文件列表上方,标有“添加文件”的按钮以深橙色框出。 在存储库的文件树状视图中,带加号图标的按钮也以深橙色框出。

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

  4. 在“编辑新文件”选项卡中,添加有关用户如何获取项目支持的信息。

  5. 若要查看 SUPPORT 文件,请单击“预览”。

  6. 单击“提交更改...”

  7. 在“提交消息”字段中,输入简短、有意义的提交消息,以描述对文件的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建有多个作者的提交”。

  8. 如果在 GitHub.com 上有多个电子邮件地址与你的帐户关联,请单击电子邮件地址下拉菜单,然后选择要用作 Git 作者电子邮件地址的电子邮件地址。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果启用了电子邮件地址隐私,则使用无回复电子邮件地址作为默认提交作者的电子邮件地址。 有关无回复电子邮件地址可以采用的确切格式的详细信息,请参阅“设置提交电子邮件地址”。

    GitHub 拉取请求的屏幕截图,其中显示了一个下拉菜单,包含用于选择提交作者电子邮件地址的选项。 已选择 octocat@github.com。

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

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。

  10. 单击“提交更改”或“建议更改” 。