Skip to main content
Skip to content

将辅助功能页添加到存储库

添加一个 ACCESSIBILITY.md 文件,使项目的辅助功能信息易于查找,并为用户提供一种清晰的方式来报告障碍。

当存储库包含 ACCESSIBILITY.md 文件时, GitHub 在存储库概述上显示 辅助功能 选项卡,并链接到存储库的“ 关于 ”部分的页面。

GitHub 按该顺序查找目录中的文件 .github 、存储库根目录和 docs 目录。 如果存储库不包含辅助功能页,它可以从组织拥有的存储库 .github 继承一个。

辅助功能页面可以描述项目的辅助功能优先级、支持的环境、已知障碍、参与者期望、报告过程、所有权和维护。

从社区标准添加辅助功能页

对于公共存储库,可以从辅助功能页面模板开始。

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

  2. 在存储库名称下,单击“ Insights”选项卡****。

    存储库的主页的屏幕截图。 在水平导航栏中,以橙色框出了标有图形图标和“见解”的选项卡。

  3. 在左侧边栏中,单击“ 社区标准”。

  4. 在“其他社区文件”下,找到“辅助功能”,然后单击“ 添加 或 建议”。

  5. 将模板中的说明替换为项目的辅助功能相关信息。 这些指令存储在注释中,GitHub呈现文件时不会显示。

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

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

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

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

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

手动创建辅助功能页

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

  2. 在文件列表上方,选择“Add file” 下拉菜单,然后单击“ Create new file”********。

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

    仓库主页的屏幕截图,其中突出显示了“添加文件”和“加号”两个图标(如上所述以橙色框出)。

  3. 在文件名字段中,键入 ACCESSIBILITY.md。 若要将 .github 文件存储在或 docs 目录中,请键入 .github/ACCESSIBILITY.md 或 docs/ACCESSIBILITY.md。

  4. 在 “编辑新文件 ”选项卡上,添加辅助功能相关信息。

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

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

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

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

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

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

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