GitHub 将支持资源添加到项目
您可以创建 SUPPORT 文件,让人们知道获取项目相关帮助的方式。
要将人们定向到特定的支持资源,您可以将 SUPPORT 文件添加到仓库的根文件夹 docs
或 .github
。 当有人在您的仓库中创建议题时,就会看到项目 SUPPORT 文件的链接。
您可以为组织或用户帐户创建默认的参与指南。 更多信息请参阅“创建默认社区健康文件”。
提示:为帮助人们查找您的支持指南,您可以从仓库其他位置(如自述文件)链接到 SUPPORT 文件。
将支持资源添加到项目
- 在 GitHub 上,导航到仓库的主页面。
- . 在文件列表上方,使用 Add file 下拉菜单,点击Create new file。
- 在文件名字段中,输入 SUPPORT.md(全大写)。
- 在 Edit new file(编辑新文件)选项卡中,添加人们如何获取项目支持的信息。
- 要查阅 SUPPORT 文件,请单击 Preview(预览)。
- 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。
- 以下是提交消息字段,请单击电子邮件地址下拉菜单并选择 Git 作者电子邮件地址。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果您启用了电子邮件地址隐私保护,则
<username>@users.noreply.github.com
为默认的提交作者电子邮件地址。 更多信息请参阅“设置提交电子邮件地址”。
- 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。如果当前分支是默认分支,则应选择为提交创建一个新分支,然后创建一个拉取请求。更多信息请参阅“创建新的拉取请求”。
- 单击 Propose new file(提议新文件)。