本指南将引导您完成 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 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 存储库,无论是您自己的存储库还是其他用户的复刻。 当你从 Git 连接到 GitHub.com 上的存储库时,需要使用 HTTPS 或 SSH 向 GitHub 进行身份验证。 有关详细信息,请参阅“关于远程仓库”。
3. 选择如何与 GitHub 互动
每个人都有自己独特的工作流程,用于与 GitHub 互动;您使用的接口和方法取决于您的偏好和需求。
有关如何使用以下每一种方法向 GitHub 进行身份验证的详细信息,请参阅“关于向 GitHub 验证”。
方法 | 说明 | 用例 |
---|---|---|
浏览到 GitHub.com | 如果您不需要在本地处理文件,GitHub 可让您直接在浏览器中完成大多数与 Git 相关的操作,从创建和复刻存储库到编辑文件和打开拉取请求。 | 如果您想要一个可视化界面,并且需要执行不需要在本地工作的快速、简单更改,则此方法非常有用。 |
GitHub Desktop | GitHub Desktop 可扩展并简化您的 GitHub.com 工作流程,它使用可视界面,而不是在命令行上使用命令文本。 有关 GitHub Desktop 入门的详细信息,请参阅“GitHub Desktop 使用入门”。 | 如果您需要或想要在本地处理文件,但更喜欢使用可视化界面来使用 Git 并与 GitHub 交互,则此方法最佳。 |
IDE 或文本编辑器 | 可以设置默认文本编辑器(如 Visual Studio Code)以使用 Git 打开和编辑文件、使用扩展和查看项目结构。 有关详细信息,请参阅“关联文本编辑器与 Git”。 | 如果您正在处理更复杂的文件和项目,并且希望所有内容都在一个地方,这将很方便,因为文本编辑器或 IDE 通常允许您直接访问编辑器中的命令行。 |
命令行,带或不带 GitHub CLI | 要最精细地控制和自定义如何使用 Git 以及与 GitHub 交互的方式,可以使用命令行。 有关使用 Git 命令的详细信息,请参阅“Git 备忘清单”。 GitHub CLI 是一个可以安装的命令行工具,可将拉取请求、问题、GitHub Actions | |
和其他 GitHub 功能引入终端,让你可以在一个地方完成所有工作。 有关详细信息,请参阅“关于 GitHub CLI”。 | 如果您已经使用命令行,或者您更习惯于使用命令行,这样最方便,可以避免切换上下文。 | |
GitHub API | GitHub 有 REST API 和 GraphQL API,您可以使用它们与 GitHub 进行交互。 有关详细信息,请参阅“Comparing GitHub's REST API and GraphQL API”。 | 如果要自动执行常见任务、备份数据或创建扩展 GitHub 的集成,则 GitHub API 将非常有用。 |
4. 在 GitHub 上编写
为了使您的通信清晰明了,在议题和拉取请求中井井有条,您可以使用 GitHub Flavored Markdown 进行格式化,结合易读、易写语法与一些自定义功能。 有关详细信息,请参阅“关于在 GitHub 上编写和设置格式”。
可以通过 GitHub Skills 上的“使用 Markdown 进行通信”课程了解 GitHub 风格的 Markdown。
5. 在 GitHub 上搜索
我们的集成搜索可让您在 GitHub 上的众多存储库、用户和代码行中查找所要的内容。 您可以全局搜索所有 GitHub,或将搜索限于特定仓库或组织。 有关可以对 GitHub 进行的搜索类型的详细信息,请参阅“关于在 GitHub 上搜索”。
我们的搜索语法允许您使用限定符构建查询,以指定要搜索的内容。 有关要在搜索中使用的搜索语法的详细信息,请参阅“在 GitHub 上搜索”。
6. 管理 GitHub 上的文件
使用 GitHub,您可以在存储库或您具有写入权限的任何存储库中创建、编辑、移动和删除文件。 您还可以逐行跟踪文件中更改的历史记录。 有关详细信息,请参阅“管理文件”。
第 3 部分:在 GitHub 上进行协作
任意数量的人都可以在 GitHub 的存储库中一起工作。 您可以配置设置、创建项目板和管理通知,以鼓励有效的协作。
1. 使用存储库
创建仓库
仓库就像项目的文件夹。 你的个人帐户中可以有任意数量的公共和私有存储库。 存储库可以包含文件夹和文件、图像、视频、电子表格和数据集,以及存储库中所有文件的修订历史记录。 有关详细信息,请参阅“关于仓库”。
创建新存储库时,应使用 README 文件初始化存储库,以便让人们了解您的项目。 有关详细信息,请参阅“创建新仓库”。
克隆仓库
您可以将现有存储库从 GitHub 克隆到本地计算机,从而更轻松地添加或删除文件、修复合并冲突或进行复杂提交。 克隆存储库将提取 GitHub 在当时拥有的所有存储库数据的完整副本,包括项目每个文件和文件夹的所有版本。 有关详细信息,请参阅“克隆仓库”。
复刻仓库
复刻是您管理的存储库的副本,除非您向项目所有者提交拉取请求,否则您所做的任何更改都不会影响原始存储库。 复刻最常见的用法是对其他人的项目提出更改或将其他人的项目用作自己创意的起点。 有关详细信息,请参阅“使用复刻”。
2. 导入项目
如果您有要移动到 GitHub 的现有项目,则可以使用 GitHub 导入程序、命令行或外部迁移工具导入项目。 有关详细信息,请参阅“导入源代码”。
3. 管理协作者和权限
您可以使用仓库议题、拉取请求及项目板与其他人协作处理您的项目。 可以从存储库设置中的“协作者”选项卡中邀请其他人作为协作者加入你的存储库。 有关详细信息,请参阅“邀请协作者参加个人仓库”。
你是在个人帐户中创建的任何存储库的所有者,并拥有对存储库的完全控制。 协作者对您的存储库具有写入权限,他们的操作权限有限。 有关详细信息,请参阅“个人帐户存储库的权限级别”。
4. 管理存储库设置
作为存储库的所有者,您可以配置多个设置,包括存储库的可见性、主题和社交媒体预览。 有关详细信息,请参阅“管理存储库的设置和功能”。
5. 设置项目以获得正常的贡献
为了鼓励存储库中的协作者,你需要一个鼓励人们使用、参与和宣传你的项目的社区。 有关详细信息,请参阅开源指南中的“构建友好社区”。
通过向存储库添加贡献指南、行为准则和许可证等文件,您可以营造一个环境,让协作者更容易做出有意义、有用的贡献。 有关详细信息,请参阅“设置项目的健康贡献”。
6. 使用 GitHub 问题和项目板
您可以使用 GitHub Issues 来组织工作议题和拉取请求,并使用项目板管理工作流程。 有关详细信息,请参阅“关于议题”和“关于 projects (classic)”。
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 apps 和 GitHub Actions。
2. 使用 GitHub API
GitHub API 有两个版本:REST API 和 GraphQL API。 要自动执行常见任务、备份数据或创建扩展 GitHub 的集成,可以使用 GitHub API。 有关详细信息,请参阅“Comparing GitHub's REST API and GraphQL API”。
3. 构建 GitHub Actions
使用 GitHub Actions,可以在 GitHub 上自动执行和自定义 GitHub.com 的开发工作流。 您可以创建自己的操作,以及使用和自定义 GitHub 社区分享的操作。 有关详细信息,请参阅“了解 GitHub Actions”。
4. 发布和管理 GitHub Packages
GitHub Packages 是一种软件包托管服务,允许您私下或公开托管软件包,并将包用作项目中的依赖项。 有关详细信息,请参阅“GitHub Packages 简介”。
第 5 部分:在 GitHub 上安全地构建
GitHub 具有各种安全功能,有助于确保存储库中代码和机密的安全。 某些功能适用于所有存储库,而另一些功能仅适用于公共存储库和具有 GitHub Advanced Security 许可证的存储库。 有关 GitHub 安全功能的概述,请参阅“GitHub 安全功能”。
1. 保护存储库
作为存储库管理员,您可以通过配置存储库安全设置来保护您的存储库。 其中包括管理对存储库的访问、设置安全策略和管理依赖项。 对于公共存储库以及启用了 GitHub Advanced Security 的组织拥有的私有存储库,您还可以配置代码和机密扫描以自动识别漏洞并确保令牌和密钥不会公开。
有关可保护存储库的步骤的详细信息,请参阅“保护您的仓库”。
2. 管理依赖项
安全构建的很大一部分是维护项目的依赖项,以确保所依赖的所有包和应用程序都已更新且安全。 通过浏览存储库的依赖关系图,使用 Dependabot 自动引发拉取请求以使依赖项保持最新,以及接收依赖项的警报和易受攻击依赖项的安全更新,您可以管理上 GitHub 存储库的依赖关系。
有关详细信息,请参阅“保护软件供应链”。
第 6 部分:参与 GitHub 的社区
有多种方法可以参与 GitHub 社区。 你可以参与开放源代码项目、与 GitHub Community Support 中的人员交互,或者通过 GitHub Skills 学习。
1. 参与开源项目
为 GitHub 上的开源项目做出贡献可能是学习、教授你能想象到的任何技能和积累相关经验的一种有益方式。 有关详细信息,请参阅开源指南中的“如何为开放源代码做出贡献”。
可以在探索 GitHub 中找到基于过去的贡献、星级和其他活动的项目及合适的第一个议题的个性化建议。有关详细信息,请参阅“寻找在 GitHub 上参与开源项目的方法”。
2. 与 GitHub Community Support
互动
你可以与世界各地的开发者建立联系,以提出和解答问题、学习,以及直接与 GitHub 工作人员互动。 若要开始对话,请参阅“GitHub Community Support”。
3. 在 GitHub Docs
上阅读 GitHub
可阅读反映 GitHub 可用功能的文档。 有关详细信息,请参阅“关于 GitHub 文档的版本”。
4. 通过 GitHub Skills
学习
你可以通过 GitHub Skills 在自己的 GitHub 存储库中完成有趣、逼真的项目来学习新技能。 每门课程都是由 GitHub 社区创建并由友好的机器人教授的实践课程。
有关详细信息,请参阅“Git 和 GitHub 学习资源”。
5. 支持开源社区
使用 GitHub Sponsors,可以向设计、创建或维护你所依赖的开源项目的开发者或组织每月定期付款。 有关详细信息,请参阅“关于 GitHub 赞助商”。
6. 联系 GitHub 支持
GitHub 支持 可帮助您排除在使用 GitHub 时遇到的问题。 有关详细信息,请参阅“关于 GitHub 支持”。