GitHub 关于自述文件
  1. GitHub 入门指南
    1. GitHub 快速入门
      1. GitHub 设置 Git
      2. GitHub 创建仓库
      3. GitHub 复刻仓库
      4. GitHub 社交化
    2. 了解 GitHub
      1. GitHub 的产品
      2. GitHub 通过功能预览提早了解发行版
      3. GitHub 帐户的类型
      4. 有关 GitHub 计划变更的常见问题解答
      5. GitHub CLI
      6. GitHub Desktop
      7. 手机版 GitHub
      8. GitHub 上的访问权限
      9. GitHub 词汇表
      10. GitHub Git 备忘清单
      11. Git 和 GitHub 学习资源
    3. 注册 GitHub
      1. 注册新 GitHub 帐户
      2. GitHub 验证电子邮件地址
      3. 设置 GitHub Enterprise Cloud 试用版
      4. 设置 GitHub Enterprise Server 试用版
    4. 在 GitHub 上探索项目
      1. 寻找在 GitHub 上参与开源项目的方法
      2. GitHub 使用星标保存仓库
      3. GitHub 关注他人
    5. 使用 GitHub
      1. GitHub 支持的浏览器
      2. GitHub 连接问题故障排除
      3. GitHub 键盘快捷键
  2. GitHub 用户帐户
    1. GitHub 管理用户帐户设置
      1. GitHub 关于个人仪表板
      2. 更改 GitHub 用户名
      3. GitHub 合并多个用户帐户
      4. GitHub 将用户转换为组织
      5. GitHub 删除用户帐户
      6. GitHub 用户帐户仓库的权限级别
      7. GitHub 用户拥有的项目板的权限级别
      8. GitHub 管理用户帐户的安全性和分析设置
      9. GitHub 管理对用户帐户项目板的访问
      10. GitHub 关于离开公司的最佳实践
      11. GitHub “招聘职位”复选框有什么作用？
    2. GitHub 管理电子邮件首选项
      1. 添加电子邮件地址到 GitHub 帐户
      2. GitHub 更改主电子邮件地址
      3. GitHub 设置备用电子邮件地址
      4. GitHub 设置提交电子邮件地址
      5. GitHub 阻止会暴露个人电子邮件地址的命令行推送
      6. 记住您的 GitHub 用户名或电子邮件
      7. GitHub 发送的电子邮件类型
      8. 管理来自 GitHub 的营销电子邮件
    3. GitHub 管理对个人仓库的访问
      1. GitHub 邀请协作者参加个人仓库
      2. GitHub 从个人仓库中删除协作者
      3. GitHub 从协作者的仓库中删除您自己
      4. GitHub 保持用户帐户仓库的所有权连续性
    4. GitHub 管理组织中的成员资格
      1. GitHub 关于组织成员资格
      2. GitHub 访问组织
      3. GitHub 查看组织中人员的角色
      4. GitHub 请求组织批准 OAuth 应用程序
      5. GitHub 公开或隐藏组织成员关系
      6. GitHub 管理您的预定提醒
      7. GitHub 从组织中删除自己
  3. GitHub 个人资料
    1. GitHub 自定义个人资料
      1. GitHub 关于您的个人资料
      2. GitHub 关于组织的资料
      3. GitHub 个性化您的个人资料
      4. GitHub 管理您的个人资料 README
      5. GitHub 在个人资料中嵌入项目
    2. GitHub 管理个人资料中的贡献图
      1. GitHub 在个人资料中查看贡献
      2. GitHub 在个人资料中显示活动概览
      3. GitHub 在个人资料中公开或隐藏您的私人贡献
      4. 将 GitHub Enterprise Server 贡献发送给 GitHub.com 配置文件
      5. GitHub 为什么我的贡献没有在我的个人资料中显示？
      6. GitHub 对时间表上的提交进行故障排除
  4. GitHub 身份验证
    1. GitHub 保护帐户和数据安全
      1. 关于向 GitHub 验证
      2. GitHub 创建强密码
      3. 更新 GitHub 访问凭据
      4. GitHub 创建个人访问令牌
      5. GitHub 审查 SSH 密钥
      6. GitHub 审查您的部署密钥
      7. GitHub 授权 OAuth 应用程序
      8. GitHub 审查授权的集成
      9. GitHub 连接第三方应用程序
      10. GitHub 审查您的授权应用程序 (OAuth)
      11. GitHub 审查您的安全日志
      12. GitHub 从仓库中删除敏感数据
      13. GitHub 关于匿名化图像 URL
      14. 关于 GitHub 的 IP 地址
      15. GitHub 的 SSH 密钥指纹
      16. GitHub Sudo 模式
      17. GitHub 防止未授权的访问
    2. GitHub 使用双重身份验证 (2FA) 保护您的帐户
      1. GitHub 关于双重身份验证
      2. GitHub 配置双重身份验证
      3. GitHub 配置双重身份验证恢复方法
      4. 使用双重身份验证访问 GitHub
      5. GitHub 丢失 2FA 凭据时恢复帐户
      6. GitHub 更改移动设备的双重身份验证递送方式
      7. GitHub 支持 SMS 身份验证的国家/地区
      8. GitHub 禁用个人帐户的双重身份验证
    3. GitHub 使用 SAML 单点登录进行身份验证
      1. GitHub 关于使用 SAML 单点登录进行身份验证
      2. GitHub 授权用于 SAML 单点登录的 SSH 密钥
      3. GitHub 授权用于 SAML 单点登录的个人访问令牌
      4. GitHub 查看和管理活动的 SAML 会话
    4. 使用 SSH 连接到 GitHub
      1. GitHub 关于 SSH
      2. GitHub 检查现有 SSH 密钥
      3. GitHub 生成新 SSH 密钥并添加到 ssh-agent
      4. 新增 SSH 密钥到 GitHub 帐户
      5. GitHub 测试 SSH 连接
      6. GitHub 使用 SSH 密钥密码
    5. GitHub SSH 故障排除
      1. GitHub 在 HTTPS 端口使用 SSH
      2. GitHub 恢复 SSH 密钥密码
      3. GitHub 已删除或缺少的 SSH 密钥
      4. GitHub 错误：权限被拒绝（公钥）
      5. GitHub 错误：文件编号错误
      6. GitHub 错误：密钥已被使用
      7. GitHub 错误：用户/仓库拒绝其他用户的权限
      8. GitHub 错误：用户/仓库拒绝用户/其他仓库的权限
      9. GitHub 错误：代理承认没有签署
      10. GitHub 错误：ssh-add：非法选项 -- K
      11. GitHub 错误：SSL 证书有问题，请验证 CA 证书是否正常
      12. GitHub 错误：我们正在进行 SSH 密钥审核
    6. GitHub 管理提交签名验证
      1. GitHub 关于提交签名验证
      2. GitHub 检查现有 GPG 密钥
      3. GitHub 生成新 GPG 密钥
      4. 新增 GPG 密钥到 GitHub 帐户
      5. GitHub 将您的签名密钥告知 Git
      6. GitHub 将电子邮件与 GPG 密钥关联
      7. GitHub 对提交签名
      8. GitHub 对标记签名
    7. GitHub 对提交签名验证进行故障排除
      1. GitHub 检查提交和标记签名验证状态
      2. GitHub 更新过期的 GPG 密钥
      3. GitHub 在 GPG 密钥中使用经验证的电子邮件地址
  5. 在 GitHub 上管理订阅和通知
    1. GitHub 设置通知
      1. GitHub 关于通知
      2. GitHub 配置通知
    2. GitHub 查看和分类通知
      1. GitHub 从收件箱管理通知
      2. GitHub 对单个通知进行分类
      3. GitHub 自定义对通知分类的工作流程
    3. 在 GitHub 上管理活动的订阅
      1. GitHub 查看订阅
      2. GitHub 管理订阅
  6. GitHub 组织和团队
    1. GitHub 与组织中的团体协作
      1. GitHub 关于组织
      2. GitHub 关于组织仪表板
      3. GitHub 从头开始创建新组织
      4. GitHub 访问组织的设置
      5. GitHub 关于组织的消息馈送
      6. GitHub 查看组织的洞察
    2. GitHub 管理组织中的成员资格
      1. GitHub 邀请用户参加您的组织
      2. GitHub 取消或编辑加入组织的邀请
      3. GitHub 从组织中删除成员
      4. GitHub 恢复组织的前成员
      5. GitHub 我可以为组织中的人员创建帐户吗？
    3. GitHub 使用角色管理人们对您的组织的访问
      1. GitHub 组织的权限级别
      2. GitHub 保持组织的所有权连续性
      3. GitHub 向组织成员授予“团队维护员”权限
      4. 为组织添加帐单管理员
      5. 从组织中删除帐单管理员
    4. GitHub 将成员组织为团队
      1. GitHub 关于团队
      2. GitHub 创建团队
      3. GitHub 设置团队的头像
      4. GitHub 添加组织成员到团队
      5. GitHub 管理团队的代码审查分配
      6. GitHub 重命名团队
      7. GitHub 更改团队可见性
      8. GitHub 将团队与身份提供程序组同步
      9. GitHub 在组织的层次结构中移动团队
      10. GitHub 申请添加子团队
      11. GitHub 申请添加或更改父团队
      12. GitHub 从团队中删除组织成员
      13. GitHub 禁用组织的团队讨论
      14. GitHub 管理团队的预定提醒
      15. GitHub 删除团队
    5. GitHub 管理对组织仓库的访问
      1. GitHub 组织的仓库权限级别
      2. GitHub 设置组织的基本权限
      3. GitHub 查看具有仓库访问权限的人员
      4. GitHub 管理个人对组织仓库的访问
      5. GitHub 管理团队对组织仓库的访问
      6. GitHub 添加外部协作者到组织的仓库
      7. GitHub 取消成为组织外部协作者的邀请
      8. GitHub 从组织仓库中删除外部协作者
      9. GitHub 将组织成员转换为外部协作者
      10. GitHub 将外部协作者转换为组织成员
      11. GitHub 恢复前外部协作者对组织的访问权限
    6. GitHub 管理对组织项目板的访问
      1. GitHub 组织的项目板权限
      2. GitHub 管理组织成员对项目板的访问
      3. GitHub 管理团队对组织项目板的访问
      4. GitHub 管理个人对组织项目板的访问
      5. GitHub 添加外部协作者到组织的项目板
      6. GitHub 从组织项目板删除外部协作者
    7. GitHub 管理对组织应用程序的访问
      1. 为组织添加 GitHub 应用程序管理员
      2. 从组织中删除 GitHub 应用程序管理员
    8. GitHub 管理组织设置
      1. GitHub 验证组织的域
      2. GitHub 重命名组织
      3. GitHub 转让组织所有权
      4. GitHub 限制在组织中创建仓库
      5. GitHub 设置删除或转让仓库的权限
      6. GitHub 限制在组织中更改仓库可见性
      7. GitHub 管理组织的复刻政策
      8. 禁用或限制组织的 GitHub 操作
      9. GitHub 设置添加外部协作者的权限
      10. GitHub 允许人们删除组织中的议题
      11. GitHub 设置组织中的团队创建权限
      12. GitHub 管理组织的预定提醒
      13. GitHub 管理组织中仓库的默认标签
      14. GitHub 更改组织依赖项洞察图的可见性
      15. GitHub 管理组织中成员名称的显示
      16. GitHub 删除组织帐户
      17. GitHub 将组织转换为用户
      18. GitHub 升级到公司服务条款
      19. 与 GitHub 签订数据保护协议以符合 GDPR 标准
    9. GitHub 迁移到改进的组织权限
      1. GitHub 将所有者团队转换为改进的组织权限
      2. GitHub 将管理员团队转换为改进的组织权限
      3. GitHub 将管理团队迁移到改进的组织权限
    10. GitHub 限制对组织数据的访问
      1. GitHub 关于 OAuth App 访问限制
      2. GitHub 对组织启用 OAuth App 访问限制
      3. GitHub 禁用 OAuth 应用程序对您的组织的访问权限限制
      4. GitHub 批准组织的 OAuth Apps
      5. GitHub 拒绝此前批准的 OAuth 应用程序对组织的访问权限
    11. GitHub 保护组织安全
      1. GitHub 查看组织中的用户是否已启用 2FA
      2. GitHub 准备在组织中要求双重身份验证
      3. GitHub 您的组织中需要双重身份验证
      4. GitHub 管理组织的安全性和分析设置
      5. GitHub 管理组织的密码扫描
      6. GitHub 管理组织允许的 IP 地址
      7. GitHub 将电子邮件通知限于已批准的域
      8. GitHub 审查组织的审核日志
      9. GitHub 审查组织安装的集成
    12. GitHub 管理组织的 SAML 单点登录
      1. GitHub 关于使用 SAML 单点登录管理身份和访问
      2. GitHub 关于 SCIM
      3. GitHub 将身份提供程序连接到组织
      4. GitHub 使用 Octa 配置 SAML 单个登录和 SCIM
      5. GitHub 启用和测试组织的 SAML 单点登录
      6. GitHub 准备在组织中实施 SAML 单点登录
      7. GitHub 实施组织的 SAML 单点登录
      8. GitHub 下载组织的 SAML 单点登录恢复代码
      9. GitHub 管理组织的团队同步
      10. GitHub 身份提供程序不可用时访问组织
    13. GitHub 使用 SAML 单点登录授予对组织的访问
      1. GitHub 使用 SAML 单点登录管理自动程序和服务帐户
      2. GitHub 查看和管理成员对组织的 SAML 访问
      3. GitHub 关于双重身份验证和 SAML 单点登录
    14. GitHub 管理对组织仓库的 Git 访问
      1. GitHub 关于 SSH 认证中心
      2. GitHub 管理组织的 SSH 认证中心
  7. GitHub 企业帐户
    1. GitHub 管理企业帐户
      1. GitHub 关于企业帐户
      2. GitHub 查看企业帐户的订阅和使用情况
    2. GitHub 管理企业帐户中的用户
      1. GitHub 企业帐户的角色
      2. GitHub 邀请人员管理企业帐户
      3. GitHub 查看企业帐户中的人员
      4. GitHub 查看和管理用户对企业帐户的 SAML 访问
    3. GitHub 管理企业帐户中的组织
      1. GitHub 将组织添加到企业帐户
      2. GitHub 管理企业帐户中没有所有者的组织
      3. GitHub 查看企业帐户中组织的审核日志
      4. GitHub 为企业帐户中的组织事件配置 web 挂钩
    4. GitHub 为企业帐户中的组织设置策略
      1. GitHub 在企业帐户中实施仓库管理策略
      2. GitHub 在企业帐户中实施项目板策略
      3. GitHub 在企业帐户中实施团队策略
      4. GitHub 在企业帐户中实施安全设置
      5. GitHub 使用 Okta 为企业帐户配置 SAML 单点登录和 SCIM
      6. GitHub 在企业帐户中实施关于依赖项洞察的策略
      7. 在企业帐户中实施 GitHub 操作策略
  8. GitHub 计费和付款
    1. 管理 GitHub 计费设置
      1. 关于 GitHub 的计费
      2. GitHub 查看订阅和结算日期
      3. GitHub 添加或编辑付款方式
      4. GitHub 查看您的付款历史记录和收据
      5. GitHub 添加信息到收据
      6. GitHub 设置帐单邮箱
      7. GitHub 更改结算周期的时长
      8. GitHub 兑换优惠券
      9. GitHub 对拒绝的信用卡收费进行故障排除
      10. GitHub 解锁锁定的帐户
      11. GitHub 删除付款方式
    2. 管理 GitHub 帐户的计费
      1. 关于 GitHub 帐户的计费
      2. GitHub 关于每用户定价
      3. GitHub 升级或降级对结算过程有何影响？
      4. 升级 GitHub 订阅
      5. GitHub 查看和管理对订阅的待定更改
      6. 降级 GitHub 订阅
      7. GitHub 帐户折扣订阅
    3. 管理 GitHub Marketplace 应用程序的计费
      1. 关于 GitHub Marketplace 的计费
      2. 升级 GitHub Marketplace 应用程序的结算方案
      3. 降级 GitHub Marketplace 应用程序的结算方案
      4. 取消 GitHub Marketplace 应用程序
    4. 管理 GitHub 操作的计费
      1. 关于 GitHub 操作的计费
      2. 查看 GitHub 操作使用情况
      3. 管理 GitHub 操作的支出限额
    5. GitHub 管理 Git Large File Storage 的计费
      1. GitHub 关于 Git Large File Storage 的计费
      2. GitHub 查看您的 Git Large File Storage 使用情况
      3. GitHub 升级 Git Large File Storage
      4. GitHub 降级 Git Large File Storage
    6. 管理 GitHub 赞助者的计费
      1. 关于 GitHub 赞助者的计费
      2. GitHub 升级赞助
      3. GitHub 降级赞助
    7. 管理 GitHub 包的计费
      1. 关于 GitHub 包的计费
      2. 查看 GitHub 包使用情况
      3. 管理 GitHub 包的支出限额
    8. GitHub 为采购公司设置付费组织
      1. GitHub 关于采购公司的组织
      2. GitHub 代客户创建并支付组织
      3. GitHub 升级或降级客户的付费组织
      4. GitHub 续订客户的付费组织
  9. 在 GitHub 上编写
    1. 开始在 GitHub 上编写和格式化
      1. 关于在 GitHub 上编写和设置格式
      2. GitHub 基本撰写和格式语法
    2. GitHub 使用高级格式
      1. GitHub 使用表格组织信息
      2. GitHub 创建和突显代码块
      3. GitHub 自动链接的引用和 URL
    3. GitHub 使用已保存回复
      1. GitHub 关于已保存回复
      2. GitHub 创建已保存回复
      3. GitHub 编辑已保存回复
      4. GitHub 删除已保存回复
      5. GitHub 使用已保存回复
    4. GitHub 编辑内容以及与 gist 共享内容
      1. GitHub 创建 Gist
      2. GitHub 复刻和克隆 Gist
  10. GitHub 创建、克隆和存档仓库
    1. 在 GitHub 上创建仓库
      1. GitHub 关于仓库
      2. GitHub 关于仓库可见性
      3. GitHub 创建新仓库
      4. GitHub 从模板创建仓库
      5. GitHub 关于自述文件
      6. GitHub 关于代码所有者
      7. GitHub 关于仓库语言
      8. GitHub 许可仓库
      9. GitHub 创建模板仓库
      10. GitHub 创建仅含议题的仓库
      11. GitHub 限制查看仓库中的内容和差异
      12. GitHub 复制仓库
    2. 从 GitHub 克隆仓库
      1. GitHub 克隆仓库
      2. GitHub HTTPS 克隆错误
      3. GitHub 错误：未找到仓库
      4. GitHub 错误：远程 HEAD 引用不存在的 ref，无法检出
    3. 存档 GitHub 仓库
      1. GitHub 关于存档仓库
      2. GitHub 存档仓库
      3. 关于在 GitHub 上存档内容和数据
      4. GitHub 参考和引用内容
      5. GitHub 备份仓库
  11. GitHub 使用 Git
    1. Git 和 GitHub 使用入门
      1. GitHub 在 Git 中设置用户名
      2. 在 Git 中缓存 GitHub 凭据
      3. GitHub 为什么 Git 总是询问我的密码？
      4. GitHub 更新 OSX 密钥链中的凭据
    2. GitHub 了解 Git
      1. GitHub Git 工作流程
      2. GitHub 关联文本编辑器与 Git
      3. GitHub 配置 Git 处理行结束符
      4. GitHub 忽略文件
    3. GitHub 使用常见 Git 命令
      1. GitHub 推送提交到远程仓库
      2. GitHub 从远程仓库获取更改
      3. GitHub 处理非快进错误
    4. GitHub 管理远程仓库
      1. GitHub 关于远程仓库
      2. GitHub 我应使用哪个远程 URL？
      3. GitHub 添加远程
      4. GitHub 更改远程仓库的 URL
      5. GitHub 重命名远程
      6. GitHub 删除远程
    5. GitHub 使用高级 Git 命令
      1. GitHub 更改作者信息
      2. GitHub 关于 Git 变基
      3. GitHub 在命令行中使用 Git rebase
      4. GitHub 解决 Git 变基后的合并冲突
      5. GitHub 关于 Git 子树合并
      6. GitHub 将子文件夹拆分成新仓库
  12. GitHub 提交对项目的更改
    1. GitHub 创建并编辑提交
      1. GitHub 关于提交
      2. GitHub 创建有多个作者的提交
      3. GitHub 代表组织创建提交
      4. GitHub 更改提交消息
    2. GitHub 查看和比较提交
      1. GitHub 提交分支和标记标签
      2. GitHub 比较提交
      3. GitHub 提交视图之间的差异
    3. GitHub 提交疑难解答
      1. 存在于 GitHub 上但不存在于本地克隆中的提交
      2. GitHub 我的提交为什么链接到错误的用户？
  13. GitHub 使用议题和拉取请求进行协作
    1. GitHub 流程概览
      1. GitHub 流程
      2. GitHub 关于协作开发模式
      3. 关于 GitHub 中的对话
    2. GitHub 使用复刻
      1. GitHub 关于复刻
      2. GitHub 为复刻配置远程仓库
      3. GitHub 同步复刻
      4. GitHub 将上游仓库合并到复刻
      5. GitHub 允许更改从复刻创建的拉取请求分支
      6. GitHub 删除仓库或更改其可见性时，复刻会发生什么变化？
    3. GitHub 在具有代码质量功能的仓库上进行协作
      1. GitHub 关于状态检查
    4. GitHub 通过拉取请求提议工作更改
      1. GitHub 关于分支
      2. GitHub 创建和删除仓库中的分支
      3. GitHub 关于拉取请求
      4. GitHub 关于比较拉取请求中的分支
      5. GitHub 创建拉取请求
      6. GitHub 从复刻创建拉取请求
      7. GitHub 更改拉取请求的阶段
      8. GitHub 请求拉取请求审查
      9. GitHub 更改拉取请求的基本分支
      10. GitHub 将更改提交到从复刻创建的拉取请求分支
    5. GitHub 解决合并冲突
      1. GitHub 关于合并冲突
      2. 在 GitHub 上解决合并冲突
      3. GitHub 使用命令行解决合并冲突
    6. GitHub 审查拉取请求中的更改
      1. GitHub 关于拉取请求审查
      2. GitHub 审查拉取请求中的建议更改
      3. GitHub 过滤拉取请求中的文件
      4. GitHub 在拉取请求中查找已更改的方法和函数
      5. GitHub 评论拉取请求
      6. GitHub 查看拉取请求审查
      7. GitHub 在拉取请求中加入反馈
      8. GitHub 批准需要审查的拉取请求
      9. GitHub 忽略拉取请求审查
      10. GitHub 本地检查拉取请求
    7. GitHub 合并拉取请求中的更改
      1. GitHub 关于拉取请求合并
      2. GitHub 合并拉取请求
      3. GitHub 关闭拉取请求
      4. GitHub 还原拉取请求
  14. 管理在 GitHub 上的工作
    1. GitHub 使用议题管理工作
      1. GitHub 关于议题
      2. GitHub 创建议题
      3. GitHub 删除议题
      4. GitHub 从评论打开议题
      5. GitHub 从代码打开议题
      6. GitHub 将议题转让给其他仓库
      7. GitHub 将议题固定到仓库
      8. GitHub 创建指向代码段的永久链接
      9. GitHub 关于任务列表
      10. GitHub 关于使用参数自动化议题和拉取请求
      11. GitHub 议题和拉取请求中的文件附件
      12. 分配议题和拉取请求到其他 GitHub 用户
      13. GitHub 查看所有议题和拉取请求
      14. GitHub 禁用议题
      15. GitHub 将拉取请求链接到议题
      16. GitHub 关于重复的议题和拉取请求
    2. GitHub 标记议题和拉取请求
      1. GitHub 关于标签
      2. GitHub 创建标签
      3. GitHub 应用标签到议题和拉取请求
      4. GitHub 编辑标签
      5. GitHub 删除标签
    3. GitHub 管理项目板
      1. GitHub 关于项目板
      2. GitHub 创建项目板
      3. GitHub 编辑项目板
      4. GitHub 将仓库链接到项目板
      5. GitHub 关于项目板的自动化
      6. GitHub 配置项目板的自动化
      7. GitHub 复制项目板
      8. GitHub 关闭项目板
      9. GitHub 重新打开关闭的项目板
      10. GitHub 删除项目板
      11. GitHub 在仓库中禁用项目板
      12. GitHub 删除组织中的项目板
      13. GitHub 更改项目板可见性
    4. GitHub 使用项目板跟踪工作进度
      1. GitHub 添加议题和拉取请求到项目板
      2. GitHub 添加注释到项目板
      3. GitHub 跟踪项目板上的进度
      4. GitHub 过滤项目板上的卡
      5. GitHub 存档项目板上的卡
    5. GitHub 使用里程碑跟踪工作进度
      1. GitHub 关于里程碑
      2. GitHub 创建和编辑议题及拉取请求的里程碑
      3. GitHub 将里程碑与议题及拉取请求关联
      4. GitHub 按里程碑过滤议题和拉取请求
      5. GitHub 查看里程碑的进度
    6. GitHub 查找仓库中的信息
      1. GitHub 过滤议题和拉取请求
      2. GitHub 按受理人过滤议题和拉取请求
      3. GitHub 按标签过滤议题和拉取请求
      4. GitHub 按审查状态过滤拉取请求
      5. GitHub 排序议题和拉取请求
      6. GitHub 使用搜索过滤议题和拉取请求
      7. GitHub 共享过滤器
  15. GitHub 代码空间
    1. GitHub 关于 Codespaces
    2. GitHub 为项目配置 Codespaces
    3. GitHub 创建代码空间
    4. GitHub 在代码空间中开发
    5. GitHub 个性化您账户的 Codespaces
    6. GitHub 删除代码空间
    7. GitHub 代码空间疑难解答
    8. GitHub 从 Visual Studio Code 连接到代码空间
  16. GitHub 建立强大的社区
    1. GitHub 设置项目的健康贡献
      1. GitHub 关于社区管理和调解
      2. GitHub 关于公共仓库的社区资料
      3. GitHub 访问项目的社区资料
      4. GitHub 为项目添加行为准则
      5. GitHub 设置仓库参与者指南
      6. GitHub 添加许可到仓库
      7. GitHub 将支持资源添加到项目
      8. GitHub 创建默认社区健康文件
      9. GitHub 使用标签鼓励对项目做出有益的贡献
    2. GitHub 使用模板鼓励有用的议题和拉取请求
      1. GitHub 关于议题和拉取请求模板
      2. GitHub 为仓库配置议题模板
      3. GitHub 为仓库创建拉取请求模板
      4. GitHub 手动为仓库创建单一议题模板
    3. GitHub 调解评论和对话
      1. GitHub 管理破坏性评论
      2. GitHub 锁定对话
      3. GitHub 限制仓库中的交互
      4. GitHub 限制组织中的交互
      5. GitHub 跟踪评论中的更改
      6. GitHub 管理贡献者如何报告组织仓库中的滥用行为
      7. GitHub 管理组织仓库中报告的内容
    4. 在 GitHub 上维护您的安全
      1. GitHub 阻止用户访问您的个人帐户
      2. GitHub 查看您已阻止访问您个人帐户的用户
      3. GitHub 取消阻止用户对个人帐户的访问
      4. GitHub 阻止用户访问组织
      5. GitHub 查看被阻止访问组织的用户
      6. GitHub 取消阻止用户对组织的访问
      7. GitHub 举报滥用或垃圾邮件
    5. GitHub 使用 wiki 为项目写文档
      1. GitHub 关于 wikis
      2. GitHub 添加或编辑 wiki 页面
      3. GitHub 为 wiki 创建页脚或边栏
      4. GitHub 编辑 wiki 内容
      5. GitHub 查看 wiki 的更改历史记录
      6. GitHub 更改对 wiki 的访问权限
      7. GitHub 禁用 wiki
    6. GitHub 与您的团队协作
      1. GitHub 关于团队讨论
      2. GitHub 创建团队讨论
      3. GitHub 编辑或删除团队讨论
      4. GitHub 固定团队讨论
  17. 在 GitHub 上搜索信息
    1. 开始在 GitHub 上搜索
      1. 关于在 GitHub 上搜索
      2. GitHub 了解搜索语法
      3. GitHub 搜索查询故障排除
      4. GitHub 排序搜索结果
      5. 在 GitHub Enterprise Server 中启用 GitHub.com 仓库搜索
    2. 在 GitHub 上搜索
      1. 在 GitHub 上查找文件
      2. GitHub 搜索仓库
      3. GitHub 搜索主题
      4. GitHub 搜索代码
      5. GitHub 搜索提交
      6. GitHub 搜索议题和拉取请求
      7. 搜索 GitHub Marketplace
      8. GitHub 搜索用户
      9. GitHub 搜索包
      10. GitHub 搜索 wiki
      11. GitHub 在复刻中搜索
  18. GitHub 导入项目
    1. 将源代码导入到 GitHub
      1. 关于 GitHub 导入工具
      2. 使用 GitHub 导入工具导入仓库
      3. 使用 GitHub 导入工具更新提交作者归属
      4. GitHub 使用命令行导入 Git 仓库
      5. 使用命令行添加现有项目到 GitHub
      6. GitHub 源代码迁移工具
    2. 在 GitHub 上使用 Subversion
      1. GitHub Subversion 和 Git 有哪些区别？
      2. GitHub Subversion 客户端支持
      3. GitHub 支持的 Subversion 属性
  19. GitHub 管理仓库
    1. GitHub 管理仓库设置
      1. GitHub 设置仓库可见性
      2. GitHub 管理有权访问仓库的团队和人员
      3. GitHub 使用主题对仓库分类
      4. 自定义更改的文件在 GitHub 中如何显示
      5. GitHub 关于推送到仓库的电子邮件通知
      6. GitHub 在仓库中显示赞助者按钮
      7. GitHub 自定义仓库的社交媒体预览
      8. GitHub 查看仓库的部署活动
      9. GitHub 管理仓库的复刻政策
      10. 禁用或限制仓库的 GitHub 操作
      11. GitHub 管理存储库档案中的Git LFS对象
      12. GitHub 配置自动链接以引用外部资源
      13. GitHub 重命名仓库
      14. GitHub 转让仓库
      15. GitHub 删除仓库
      16. 恢复已删除的仓库
    2. GitHub 管理仓库中的分支
      1. GitHub 设置默认分支
      2. GitHub 查看仓库中的分支
      3. GitHub 删除和恢复拉取请求中的分支
    3. GitHub 配置拉取请求合并
      1. 关于 GitHub 上的合并方法
      2. GitHub 为拉取请求配置提交压缩
      3. GitHub 为拉取请求配置提交变基
      4. GitHub 管理分支的自动删除
    4. GitHub 定义拉取请求的可合并性
      1. GitHub 关于受保护分支
      2. GitHub 配置受保护分支
      3. GitHub 关于必需状态检查
      4. GitHub 必需状态检查的类型
      5. GitHub 启用必需状态检查
      6. GitHub 关于分支限制
      7. GitHub 启用分支限制
      8. GitHub 关于拉取请求的必需审查
      9. GitHub 启用拉取请求的必需审查
      10. GitHub 关于必需提交签名
      11. GitHub 启用必需提交签名
      12. GitHub 需要线性提交历史记录
      13. GitHub 启用强制推送到受保护分支
      14. GitHub 启用删除受保护分支
    5. 在 GitHub 上发布项目
      1. GitHub 关于发行版
      2. GitHub 管理仓库中的发行版
      3. GitHub 查看仓库的发行版和标记
      4. GitHub 链接到发行版
      5. GitHub 比较发行版
      6. GitHub 使用查询参数自动化发行版表单
    6. GitHub 保护您的仓库
      1. GitHub 关于保护您的存储库
      2. GitHub 关于密码扫描
      3. GitHub 配置私有仓库的密码扫描
      4. GitHub 管理来自密码扫描的警报
      5. GitHub 管理仓库的安全性和分析设置
    7. GitHub 自动更新依赖项
      1. 关于 GitHub Dependabot 版本更新
      2. GitHub 启用和禁用版本更新
      3. GitHub 列出为版本更新配置的依赖项
      4. GitHub 管理依赖项更新的所有拉取请求
      5. GitHub 自定义依赖项更新
      6. GitHub 依赖项更新的配置选项
      7. 使用 GitHub Dependabot 保持操作的最新状态
  20. GitHub 通过图表可视化仓库数据
    1. GitHub 访问基本仓库数据
      1. GitHub 关于仓库图
      2. GitHub 查看仓库活动的摘要
      3. GitHub 查看项目的贡献者
      4. GitHub 查看仓库的流量
    2. GitHub 分析仓库内容的更改
      1. GitHub 可视化仓库中的提交
      2. GitHub 可视化仓库内容的添加和删除
    3. GitHub 了解仓库之间的连接
      1. GitHub 查看仓库的网络
      2. GitHub 列出仓库的复刻
      3. GitHub 关于依赖关系图
      4. GitHub 探索存储库的依赖关系
  21. GitHub 管理安全漏洞
    1. GitHub 管理项目中的安全漏洞
      1. GitHub 添加安全政策到仓库
      2. 关于 GitHub Security Advisories
      3. GitHub 安全通告的权限级别
      4. GitHub 创建安全通告
      5. GitHub 添加协作者到安全通告
      6. GitHub 从安全通告删除协作者
      7. GitHub 在临时私有复刻中协作以解决安全漏洞
      8. GitHub 发布安全通告
      9. GitHub 编辑安全通告
      10. GitHub 撤销安全通告
    2. GitHub 管理项目依赖项中的漏洞
      1. 浏览 GitHub Advisory Database 中的安全漏洞
      2. GitHub 关于易受攻击的依赖项的警报
      3. 配置 GitHub Dependabot 安全更新
      4. GitHub 查看和更新仓库中有漏洞的依赖项
      5. GitHub 管理组织中漏洞依赖项的警报
  22. GitHub 查找代码中的安全漏洞和错误
    1. GitHub 自动扫描代码以查找漏洞和错误
      1. GitHub 关于代码扫描
      2. GitHub 启用代码扫描
      3. GitHub 配置代码扫描
      4. GitHub 配置代码扫描以编译语言
      5. GitHub 代码扫描疑难解答
    2. GitHub 管理代码扫描的结果
      1. GitHub 管理来自代码扫描的警报
      2. 将 SARIF 文件上传到 GitHub
      3. GitHub 对代码扫描的 SARIF 支持
  23. GitHub 管理仓库中的文件
    1. 在 GitHub 上管理文件
      1. 在 GitHub 上导航代码
      2. GitHub 创建新文件
      3. GitHub 添加文件到仓库
      4. GitHub 将文件移至新位置
      5. GitHub 编辑仓库中的文件
      6. GitHub 编辑其他用户仓库中的文件
      7. GitHub 跟踪文件中的更改
      8. GitHub 删除文件
      9. GitHub 重命名文件
      10. GitHub 创建文件的永久链接
    2. GitHub 使用命令行管理文件
      1. GitHub 使用命令行提交文件到仓库
      2. GitHub 使用命令行重命名文件
      3. GitHub 使用命令行将文件移到新位置
    3. GitHub 使用非代码文件
      1. GitHub 呈现图像和比较差异
      2. GitHub 3D 文件查看器
      3. GitHub 呈现 CSV 和 TSV 数据
      4. GitHub 呈现 PDF 文档
      5. GitHub 散文文档中的呈现差异
      6. GitHub 上的地图 geoJSON 文件
      7. 在 GitHub 上使用 Jupyter Notebook 文件
  24. GitHub 管理大型文件
    1. GitHub 使用大文件
      1. GitHub 大文件的条件
      2. GitHub 从仓库的历史记录中删除文件
      3. GitHub 分发大型二进制文件
      4. GitHub 我的磁盘配额是多少？
    2. GitHub 大文件版本管理
      1. GitHub 关于 Git Large File Storage
      2. GitHub 安装 Git Large File Storage
      3. GitHub 配置 Git Large File Storage
      4. GitHub 关于存储和带宽使用情况
      5. GitHub 协作处理 Git Large File Storage
      6. GitHub 将仓库中的文件移至 Git Large File Storage
      7. GitHub 从 Git Large File Storage 中删除文件
      8. GitHub 解决 Git Large File Storage 上传失败
  25. GitHub 自定义 GitHub 工作流程
    1. GitHub 探索集成
      1. GitHub 关于集成
      2. 关于 GitHub Marketplace
      3. GitHub 扩展和集成
    2. 在 GitHub Marketplace 中购买并安装应用程序
      1. GitHub 在个人帐户中安装应用程序
      2. GitHub 在组织中安装应用程序
  26. GitHub 扩展 GitHub
    1. GitHub 开始使用 API
    2. GitHub 使用 OAuth 令牌实施 Git 自动化
    3. GitHub 关于 web 挂钩
  27. GitHub Pages
    1. GitHub Pages 使用入门
      1. 关于 GitHub Pages
      2. 创建 GitHub Pages 站点
      3. GitHub 使用主题选择器将主题添加到 GitHub Pages 站点
      4. 配置 GitHub Pages 站点的发布源
      5. 为 GitHub Pages 站点创建自定义 404 页面
      6. 使用 HTTPS 保护 GitHub Pages 站点
      7. 将子模块用于 GitHub Pages
      8. 取消发布 GitHub Pages 站点
    2. 使用 Jekyll 设置 GitHub Pages 站点
      1. 关于 GitHub Pages 和 Jekyll
      2. 使用 Jekyll 创建 GitHub Pages 站点
      3. 使用 Jekyll 在本地测试 GitHub Pages 站点
      4. 使用 Jekyll 向 GitHub Pages 站点添加内容
      5. 使用 Jekyll 为 GitHub Pages 站点设置 Markdown 处理器
      6. 使用 Jekyll 向 GitHub Pages 站点添加主题
      7. 关于 GitHub Pages 站点的 Jekyll 构建错误
      8. 排查 GitHub Pages 站点的 Jekyll 构建错误
    3. 配置 GitHub Pages 站点的自定义域
      1. 关于自定义域名和 GitHub 页面
      2. 管理 GitHub Pages 站点的自定义域
      3. 自定义域和 GitHub Pages 疑难解答
  28. GitHub 赞助者
    1. GitHub 赞助者概览
      1. 关于 GitHub 赞助商
    2. GitHub 赞助开源贡献者
      1. GitHub 赞助开源贡献者
      2. GitHub 管理赞助
    3. 通过 GitHub Sponsors 接受赞助
      1. 关于开源贡献者的 GitHub Sponsors
      2. 为您的用户帐户设置 GitHub Sponsors
      3. 为您的组织设置 GitHub Sponsors
      4. 编辑您用于 GitHub Sponsors 的个人资料详细信息
      5. GitHub 管理您的赞助目标
      6. GitHub 更改赞助等级
      7. GitHub 查看您的赞助者和赞助
      8. 从 GitHub Sponsors 管理您的付款
      9. GitHub 为赞助帐户中的事件配置 web 挂钩
      10. GitHub 联系赞助者
      11. GitHub Sponsors 的税务信息
  29. 使用 GitHub Education 进行教学和学习
    1. 在您的教育机构使用 GitHub
      1. 关于 GitHub Education
      2. GitHub 关于 Campus Experts
      3. GitHub 关于 Campus Advisors
    2. 使用 GitHub 做家庭作业
      1. 关于学生版 GitHub Education
      2. GitHub 申请学生开发包
      3. GitHub 为什么我的学生开发包申请未获得批准？
    3. 在课堂上和研究中使用 GitHub
      1. 关于适用于教育者和研究人员的 GitHub Education
      2. GitHub 申请教育者或研究人员折扣
      3. GitHub 为什么我的教育工作者或研究人员折扣申请未获得批准？
  30. 通过 GitHub Jobs 寻找人才
    1. 关于 GitHub 职位招聘
  31. 使用 GitHub 支持
    1. 关于 GitHub 支持
    2. GitHub Enterprise Cloud支持
    3. 关于对 GitHub Enterprise Cloud 的 GitHub Premium 支持
    4. GitHub Marketplace 支持
    5. GitHub 提交事件单
  32. 了解 GitHub 如何使用和保护数据
    1. 关于 GitHub 使用您的数据
    2. GitHub 请求个人帐户数据的存档
    3. GitHub 管理私有仓库的数据使用设置
    4. 选择加入或退出公共仓库的 GitHub 存档计划
  33. GitHub 站点策略
    1. GitHub 服务条款
    2. GitHub 公司服务条款
    3. GitHub 隐私声明
    4. GitHub 数据保护附录
    5. GitHub 全球隐私实践
    6. GitHub 企业云附录
    7. GitHub Enterprise Server 许可协议
    8. GitHub Enterprise 许可协议的 GitHub Connect 附录
    9. Microsoft 批量许可的 GitHub 补充条款
    10. GitHub Enterprise 订阅协议
    11. 组织的 GitHub Insights 和数据保护
    12. GitHub Enterprise Cloud 评估协议
    13. GitHub 赞助附加条款
    14. GitHub 附加产品条款
    15. GitHub 徽标政策
    16. GitHub 用户名政策
    17. GitHub 提交内容删除请求
    18. GitHub DMCA 删除政策
    19. GitHub 提交 DMCA 删除通知的指南
    20. GitHub 提交 DMCA 反对通知的指南
    21. GitHub 商标政策
    22. GitHub 敏感数据删除政策
    23. GitHub 子处理器和 Cookie
    24. GitHub 漏洞悬赏计划法律安全港
    25. GitHub 负责任地披露安全漏洞
    26. 适用于美国联邦政府用户的 GitHub 服务条款修正案
    27. GitHub 用户数据法律要求指南
    28. GitHub 政府删除政策
    29. GitHub 可接受的使用政策
    30. GitHub 关于《加州消费者隐私法案》的声明
    31. GitHub 社区指导方针
    32. GitHub 社区论坛行为准则
    33. GitHub 注册开发者协议
    34. GitHub 市场服务条款
    35. GitHub Marketplace 开发者协议
    36. GitHub 预发布计划
    37. GitHub 研究计划条款
    38. GitHub 开源应用程序条款和条件
    39. GitHub 和贸易管制
    40. GitHub 已故用户政策
    41. GitHub 反对现代奴隶制和雇佣童工的声明
    42. GitHub 反贿赂声明
    43. GitHub 礼品和招待政策
    44. GitHub 活动条款
    45. GitHub 活动行为准则
    46. GitHub GPL 合作承诺
阅读(2911) 赞(2)

GitHub 关于自述文件

2020-08-19 14:37:27 更新

您可以将自述文件添加到仓库，告知其他人您的项目为什么有用，他们可以对您的项目做什么，以及他们可以如何使用。

自述文件连同 仓库许可证、参与指南和行为准则一起，帮助您,沟通项目要求以及管理对项目的参与。

自述文件通常是访问者在访问仓库时看到的第一个项目。 自述文件通常包含以下信息：

  • 项目做什么
  • 项目为什么有用
  • 用户如何使用项目
  • 用户能从何处获取项目的帮助
  • 谁维护和参与项目

如果将自述文件放在仓库的根目录 docs 或隐藏的目录 .github 中，GitHub 将会识别您的自述文件并自动向仓库访问者显示。

Github/scientist 仓库的主页面及其自述文件

如果您将README文件添加到与您的用户名相同名称的公共存储库的根目录中，该README文件将自动出现在您的个人资料页面上。 您可以使用GitHub Flavored Markdown编辑个人资料README，以在个人资料上创建个性化部分。

README file on your username/username repository

自述文件和 blob 页面中的章节链接

许多项目使用目录和自述文件的开头将用户导向文件的不同章节。 您可以直接链接到渲染文件中的某个部分，方法是将鼠标悬停在该部分标题上以显示链接：

github/scientiorist 仓库的自述文件中的部分链接

自述文件中的相对链接和图像路径

您可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。

相对链接是相对于当前文件的链接。 例如，如果在仓库根目录下有一个自述文件，而在 docs/CONTRIBUTING.md 中有另一个文件，则自述文件中的 CONTRIBUTING.md 的相关链接如下所示：

[此项目的参与指南](docs/CONTRIBUTING.md)

GitHub 将根据您当前使用的分支自动转换相对链接或图像路径，从而使链接或路径始终有效。 您可以使用所有相对链接操作符，如 ./ 和 ../。

相对链接更便于用户克隆仓库。 绝对链接可能无法用于仓库的克隆 - 建议使用相对链接引用仓库中的其他文件。

延伸阅读

← GitHub 从模板创建仓库
GitHub 关于代码所有者 →

推荐文章

推荐教程

最新教程