本指南将指导您设置 GitHub 帐户并开始使用 GitHub 的协作和社区功能。
第 1 部分:配置您的 GitHub 帐户
开始使用 GitHub 的第一步是创建一个帐户、选择最适合您需求的产品、验证您的电子邮件、设置双重身份验证并查看您的个人资料。
GitHub 上有几种类型的帐户。每个使用 GitHub 的人都拥有自己的个人帐户,该帐户可以属于多个组织和团队。您的个人帐户是您在 GitHub.com 上的身份,代表您作为个人。
1. 创建帐户
要在 GitHub.com 上注册帐户,请导航至 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 风味 Markdown 编写 issue 和 pull request。
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 讨论
你可以为你的代码库启用 GitHub 讨论,以帮助围绕你的项目建立一个社区。维护者、贡献者和访问者可以使用讨论来分享公告、提出和回答问题,以及参与围绕目标的对话。有关更多信息,请参阅“关于讨论”。
第 4 部分:自定义和自动化你在 GitHub 上的工作
你可以使用 GitHub Marketplace、GitHub API 和现有的 GitHub 功能来自定义和自动化你的工作。
1. 使用 GitHub Marketplace
GitHub Marketplace 包含添加功能和改进你的工作流的集成。你可以在 GitHub Marketplace 中发现、浏览和安装免费和付费工具,包括 GitHub 应用、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 上自动化和自定义 GitHub.com 的开发工作流。你可以创建自己的操作,并使用和自定义 GitHub 社区共享的操作。有关更多信息,请参阅“了解 GitHub Actions”。
4. 发布和管理 GitHub Packages
GitHub Packages 是一项软件包托管服务,它允许你私下或公开托管你的软件包,并在你的项目中使用包作为依赖项。有关更多信息,请参阅“GitHub Packages 简介”。
第 5 部分:在 GitHub 上安全构建
GitHub 拥有各种安全功能,有助于在代码库中保护代码和机密。某些功能可用于所有代码库,而其他功能仅适用于公共代码库和拥有 GitHub 高级安全许可证的代码库。有关 GitHub 安全功能的概述,请参阅“GitHub 安全功能”。
1. 保护你的代码库
作为代码库管理员,你可以通过配置代码库安全设置来保护你的代码库。这些设置包括管理对代码库的访问、设置安全策略和管理依赖项。对于公开代码库,以及在启用了 GitHub 高级安全性的组织所拥有的私有代码库,你还可以配置代码和机密扫描以自动识别漏洞并确保令牌和密钥不会被泄露。
有关保护代码库可以采取的步骤的更多信息,请参阅“保护代码库的快速入门”。
2. 管理你的依赖项
安全构建的一个重要部分是维护项目的依赖项,以确保你所依赖的所有软件包和应用程序都是最新的且安全的。你可以通过浏览代码库的依赖关系图、使用 Dependabot 自动提出拉取请求以保持你的依赖项是最新的,以及接收 Dependabot 警报和易受攻击的依赖项的安全更新来管理你在 GitHub 上的代码库的依赖项。
有关更多信息,请参阅“保护你的软件供应链”。
第 6 部分:参与 GitHub 社区
有很多方法可以参与 GitHub 社区。你可以为开源项目做出贡献、与 GitHub 社区支持中的人员互动,或通过 GitHub 技能学习。
1. 为开源项目做出贡献
为 GitHub 上的开源项目做出贡献可以是一种有益的方式来学习、教授和构建几乎任何你可以想象的技能的经验。有关更多信息,请参阅开源指南中的“如何为开源做出贡献”。
你可以根据你过去的贡献、星标和其他活动在 探索 GitHub 中找到针对项目和良好首次问题的个性化建议。有关更多信息,请参阅“在 GitHub 上寻找为开源做出贡献的方法”。
2. 与 GitHub 社区支持互动
你可以与世界各地的开发者联系,提问并回答问题、学习并直接与 GitHub 员工互动。要开始对话,请参阅“GitHub 社区支持”。
3. 在 GitHub 文档中阅读有关 GitHub 的信息
你可以阅读反映 GitHub 上可供你使用的功能的文档。有关详细信息,请参阅“关于 GitHub 文档版本”。
4. 通过 GitHub 技能学习
你可以通过使用 GitHub 技能 在你自己的 GitHub 存储库中完成有趣且贴近实际的项目来学习新技能。每门课程都是由 GitHub 社区创建的动手课程,并由一个友好的机器人教授。
有关详细信息,请参阅“Git 和 GitHub 学习资源”。
5. 支持开源社区
GitHub Sponsors 允许你向设计、创建或维护你所依赖的开源项目开发人员或组织进行每月定期付款。有关详细信息,请参阅“关于 GitHub Sponsors”。
6. 联系 GitHub 支持
GitHub 支持可以帮助你解决在使用 GitHub 时遇到的问题。有关详细信息,请参阅“关于 GitHub 支持”。