本指南将引导您完成设置 GitHub 账户并开始使用 GitHub 的协作和社区功能。
第 1 部分:配置您的 GitHub 账户
开始使用 GitHub 的第一步是创建账户、选择最适合您需求的产品、验证您的电子邮件、设置双因素身份验证以及查看您的个人资料。
GitHub 上有几种类型的账户。每个使用 GitHub 的人都拥有自己的个人账户,该账户可以属于多个组织和团队。您的个人账户是您在 GitHub.com 上的身份,代表您个人。
1. 创建账户
要注册账户,请访问 https://github.com/ 并按照提示操作。
为了确保您的 GitHub 账户安全,您应该使用强壮且唯一的密码。有关更多信息,请参阅“创建强密码”。
2. 选择您的 GitHub 产品
您可以选择 GitHub Free 或 GitHub Pro 以获取对个人账户的不同功能的访问权限。如果您最初不确定要使用哪种产品,可以随时升级。
有关所有 GitHub 计划的更多信息,请参阅“GitHub 的计划”。
3. 验证您的电子邮件地址
为了确保您可以使用 GitHub 计划中的所有功能,请在注册新账户后验证您的电子邮件地址。有关更多信息,请参阅“验证您的电子邮件地址”。
4. 配置双因素身份验证
双因素身份验证或 2FA 是登录网站或应用时使用的额外安全层。我们强烈建议您配置 2FA 以确保账户安全。有关更多信息,请参阅“关于双因素身份验证”。
可选地,在配置 2FA 后,将密钥添加到您的账户以启用安全的无密码登录。请参阅“管理您的密钥”。
5. 查看您的 GitHub 个人资料和贡献图
您的 GitHub 个人资料通过您已固定到的仓库和 Gist、您选择公开的组织成员资格、您做出的贡献以及您创建的项目来向人们讲述您的工作故事。有关更多信息,请参阅“关于您的个人资料”和“查看个人资料上的贡献”。
第 2 部分:使用 GitHub 的工具和流程
要最好地使用 GitHub,您需要设置 Git。Git 负责在您的计算机上本地发生的与 GitHub 相关的所有操作。为了有效地在 GitHub 上协作,您将使用 GitHub Flavored Markdown 在问题和拉取请求中编写。
1. 学习 Git
GitHub 协作的开发方法依赖于将您本地仓库中的提交发布到 GitHub,以便其他人使用 Git 查看、获取和更新。有关 Git 的更多信息,请参阅“Git 手册”指南。有关如何在 GitHub 上使用 Git 的更多信息,请参阅“GitHub 工作流”。
2. 设置 Git
如果您计划在您的计算机上本地使用 Git,无论是通过命令行、IDE 还是文本编辑器,您都需要安装和设置 Git。有关更多信息,请参阅“设置 Git”。
如果您更喜欢使用可视化界面,可以下载并使用 GitHub Desktop。GitHub Desktop 附带 Git,因此无需单独安装 Git。有关更多信息,请参阅“GitHub Desktop 入门”。
安装 Git 后,您可以从本地计算机连接到 GitHub 仓库,无论是您自己的仓库还是其他用户的 fork。当您从 Git 连接到 GitHub.com 上的仓库时,您需要使用 HTTPS 或 SSH 对 GitHub 进行身份验证。有关更多信息,请参阅“关于远程仓库”。
3. 选择如何与 GitHub 交互
每个人都有自己独特的与 GitHub 交互的工作流程;您使用的界面和方法取决于您的偏好以及最适合您需求的方法。
有关与 GitHub 交互的不同方法以及您可以使用的工具的比较的更多信息,请参阅“连接到 GitHub”。
4. 在 GitHub 上写作
为了使您在问题和拉取请求中的沟通清晰且井然有序,您可以使用 GitHub Flavored Markdown 进行格式化,它将易于阅读、易于编写的语法与一些自定义功能相结合。有关更多信息,请参阅“关于在 GitHub 上写作和格式化”。
您可以在 GitHub Skills 上使用“使用 Markdown 进行沟通”课程学习 GitHub Flavored Markdown。
5. 在 GitHub 上搜索
我们的集成搜索允许您在 GitHub 上的众多仓库、用户和代码行中找到您要查找的内容。您可以在整个 GitHub 上全局搜索,也可以将搜索范围限制到特定仓库或组织。有关您可以在 GitHub 上执行的搜索类型的更多信息,请参阅“关于在 GitHub 上搜索”。
我们的搜索语法允许您使用限定符构建查询以指定您要搜索的内容。有关在搜索中使用的搜索语法的更多信息,请参阅“在 GitHub 上搜索”。
6. 管理 GitHub 上的文件
使用 GitHub,您可以在您的仓库或任何您具有写入权限的仓库中创建、编辑、移动和删除文件。您还可以逐行跟踪文件的更改历史记录。有关更多信息,请参阅“管理文件”。
第 3 部分:在 GitHub 上协作
任意数量的人可以在整个 GitHub 中的仓库中一起工作。您可以配置设置、创建项目和管理您的通知以鼓励有效的协作。
1. 使用仓库
创建仓库
仓库就像项目的文件夹。您的个人账户中可以包含任意数量的公共和私有仓库。仓库可以包含文件夹和文件、图像、视频、电子表格和数据集,以及仓库中所有文件的修订历史记录。有关更多信息,请参阅“关于仓库”。
创建新仓库时,您应该使用 README 文件初始化仓库,以让人们了解您的项目。有关更多信息,请参阅“创建新仓库”。
克隆仓库
您可以将现有的 GitHub 仓库克隆到您的本地计算机,从而更容易添加或删除文件、修复合并冲突或进行复杂的提交。克隆仓库会下载 GitHub 在该时间点拥有的所有仓库数据的完整副本,包括项目的每个文件和文件夹的所有版本。有关更多信息,请参阅“克隆仓库”。
派生仓库
派生是您管理的仓库的副本,您所做的任何更改都不会影响原始仓库,除非您向项目所有者提交拉取请求。通常,派生用于向其他人的项目提出更改或使用其他人的项目作为您自己想法的起点。有关更多信息,请参阅“使用派生”。
2. 导入您的项目
如果您有想要迁移到 GitHub 的现有项目,您可以使用 GitHub Importer、命令行或外部迁移工具导入项目。有关更多信息,请参阅“导入源代码”。
3. 管理协作者和权限
您可以使用仓库的问题、拉取请求和项目与他人协作处理您的项目。您可以从仓库设置中的**协作者**选项卡邀请其他人作为您的仓库协作者。有关更多信息,请参阅“邀请个人仓库的协作者”。
您是您在个人帐户中创建的任何仓库的所有者,并拥有对仓库的完全控制权。协作者对您的仓库具有写访问权限,这限制了他们被允许执行的操作。有关更多信息,请参阅“个人帐户仓库的权限级别”。
4. 管理仓库设置
作为仓库的所有者,您可以配置多个设置,包括仓库的可见性、主题和社交媒体预览。有关更多信息,请参阅“管理仓库的设置和功能”。
5. 为健康的贡献设置您的项目
为了鼓励您仓库中的协作者,您需要一个鼓励人们使用、贡献和推广您的项目的社区。有关更多信息,请参阅开源指南中的“构建受欢迎的社区”。
通过向您的仓库添加贡献指南、行为准则和许可证等文件,您可以创建一个更易于协作者做出有意义、有用的贡献的环境。有关更多信息,请参阅“为健康的贡献设置您的项目”。
6. 使用 GitHub 问题和项目
您可以使用 GitHub 问题来组织您使用问题和拉取请求的工作,并使用项目来管理您的工作流程。有关更多信息,请参阅“关于问题”和“关于项目”。
7. 管理通知
通知提供有关您已订阅或参与的 GitHub 活动的更新。如果您不再对某个对话感兴趣,则可以取消订阅、取消关注或自定义您将来收到的通知类型。有关更多信息,请参阅“关于通知”。
8. 使用 GitHub Pages
您可以使用 GitHub Pages 直接从 GitHub.com 上的仓库创建和托管网站。有关更多信息,请参阅“关于 GitHub Pages”。
9. 使用 GitHub Discussions
您可以为您的仓库启用 GitHub Discussions,以帮助围绕您的项目构建社区。维护者、贡献者和访客可以使用讨论来分享公告、提问和解答问题,以及参与围绕目标的对话。有关更多信息,请参阅“关于讨论”。
第 4 部分:自定义和自动化您在 GitHub 上的工作
您可以使用来自 GitHub Marketplace、GitHub API 和现有 GitHub 功能的工具来自定义和自动化您的工作。
1. 使用 GitHub Marketplace
GitHub Marketplace 包含可添加功能并改进工作流程的集成。您可以在GitHub Marketplace中发现、浏览和安装免费和付费工具,包括 GitHub Apps、OAuth 应用程序和 GitHub Actions。
2. 使用 GitHub API
GitHub API 有两个版本:REST API 和 GraphQL API。您可以使用 GitHub API 自动执行常见任务,备份您的数据,或创建扩展 GitHub 的集成。有关更多信息,请参阅“比较 GitHub 的 REST API 和 GraphQL API”。
3. 构建 GitHub Actions
使用 GitHub Actions,您可以自动化和自定义 GitHub.com 上的开发工作流程。您可以创建自己的操作,并使用和自定义 GitHub 社区共享的操作。有关更多信息,请参阅“编写工作流程”。
4. 发布和管理 GitHub Packages
GitHub Packages 是一种软件包托管服务,允许您私下或公开托管您的软件包,并在您的项目中使用这些软件包作为依赖项。有关更多信息,请参阅“GitHub Packages 简介”。
第 5 部分:在 GitHub 上安全构建
GitHub 拥有各种安全功能,有助于确保仓库中的代码和密钥安全。某些功能适用于所有仓库,而其他功能仅适用于公共仓库和具有 GitHub 高级安全许可证的仓库。有关 GitHub 安全功能的概述,请参阅“GitHub 安全功能”。
1. 保护您的仓库
作为仓库管理员,您可以通过配置仓库安全设置来保护您的仓库。这些设置包括管理对仓库的访问权限、设置安全策略和管理依赖项。对于公共仓库,以及对于启用了 GitHub 高级安全性的组织拥有的私有仓库,您还可以配置代码和密钥扫描以自动识别漏洞并确保不会泄露令牌和密钥。
有关您可以采取哪些步骤来保护仓库的更多信息,请参阅“保护仓库的快速入门”。
2. 管理您的依赖项
安全构建的一个重要部分是维护项目的依赖项,以确保您依赖的所有软件包和应用程序都是更新且安全的。您可以通过浏览仓库的依赖项图、使用 Dependabot 自动发出拉取请求以保持依赖项更新以及接收 Dependabot 警报和易受攻击的依赖项的安全更新来管理仓库中的依赖项。
有关更多信息,请参阅“保护您的软件供应链”。
第 6 部分:参与 GitHub 社区
有很多方法可以参与 GitHub 社区。您可以为开源项目做出贡献,与 GitHub 社区支持中的人员互动,或使用 GitHub Skills 学习。
1. 为开源项目做出贡献
为 GitHub 上的开源项目做出贡献可能是学习、教学和积累您能想象到的几乎任何技能经验的有益方式。有关更多信息,请参阅开源指南中的“如何为开源做出贡献”。
您可以在探索 GitHub中找到根据您过去的贡献、星标和其他活动提供的个性化项目和良好首个问题的推荐。有关更多信息,请参阅“查找为 GitHub 上的开源做出贡献的方法”。
2. 与 GitHub 社区支持互动
您可以与来自世界各地的开发人员联系,以提问和解答问题、学习以及直接与 GitHub 员工互动。要开始对话,请参阅“GitHub 社区支持”。
3. 阅读 GitHub Docs 上的 GitHub 信息
您可以阅读反映您在 GitHub 上可用的功能的文档。有关更多信息,请参阅“关于 GitHub Docs 的版本”。
4. 使用 GitHub Skills 学习
您可以通过使用GitHub Skills在您自己的 GitHub 仓库中完成有趣、真实的项目来学习新技能。每个课程都是 GitHub 社区创建的实践课程,由一个友好的机器人教授。
有关更多信息,请参阅“Git 和 GitHub 学习资源”。
5. 支持开源社区
GitHub Sponsors 允许您向设计、创建或维护您依赖的开源项目的开发人员或组织每月定期付款。有关更多信息,请参阅“关于 GitHub Sponsors”。
6. 联系 GitHub 支持
GitHub 支持可以帮助您解决在使用 GitHub 时遇到的问题。有关更多信息,请参阅“关于 GitHub 支持”。