本指南将指导你设置 GitHub 帐户并开始使用 GitHub“协作和社区功能”。
第 1 部分:配置 GitHub 帐户
开始使用 GitHub 时,首先需要访问您的账户、设置双重身份验证并查看您的个人资料。
每个使用 GitHub 的人都有自己的个人帐户,这些帐户可以是多个组织和团队的一部分。 个人账户是你在 你的 GitHub Enterprise Server 实例 上的身份标识,代表作为个人的你。
1. 访问你的帐户
实例的 GitHub Enterprise Server 管理员将通知你如何对帐户进行身份验证和访问。 该过程因他们为实例配置的身份验证模式而异。
2. 配置双重身份验证
双因素身份验证 (2FA) 是登录网站或应用时采用的额外安全保障。 我们强烈建议您配置 2FA 以确保帐户安全。 有关详细信息,请参阅“关于双重身份验证”。
可以选择在配置 2FA 后,将密钥添加到帐户,以启用安全的无密码登录。 请参阅“管理通行密钥”。
3. 查看你的GitHub个人资料和贡献图表
你的 GitHub 个人资料通过你固定的存储库和 gist、你选择公开的组织成员身份、你所做的贡献以及你创建的项目来讲述你的工作的故事。 有关详细信息,请参阅 关于您的个人资料 和 在个人资料中查看贡献。
第 2 部分:使用 GitHub 的工具和流程
若要充分利用 GitHub,需要设置 Git。 Git 负责你计算机本地发生的一切与 GitHub 相关的内容。 为了在 GitHub 上高效协作,你需要使用 GitHub 风格的 Markdown 在议题和拉取请求中编写内容。
1. 了解 Git
GitHub 的协作式开发方法依赖于将本地仓库中的提交发布到 GitHub,以便其他人使用 Git 查看、抓取和更新这些提交。 有关 Git 的详细信息,请参阅 Git 手册指南。 有关如何使用 GitHubGit 的详细信息,请参阅 GitHub Flow。
2. 设置 Git
如果您计划在计算机上本地使用 Git,无论是通过命令行、IDE 还是文本编辑器,您都需要安装和设置 Git。 有关详细信息,请参阅“设置 Git”。
如果希望使用可视界面,可以下载和使用 GitHub Desktop。 GitHub Desktop 随 Git 打包,因此无需单独安装 Git。 有关详细信息,请参阅“GitHub Desktop 使用入门”。
安装 Git 后,可以从本地计算机(无论是自己的存储库还是其他用户的分支)连接到 GitHub 存储库。 从 Git 连接到存储库 你的 GitHub Enterprise Server 实例 时,需要使用 HTTPS 或 SSH 进行身份验证 GitHub 。 有关详细信息,请参阅“关于远程仓库”。
3. 选择如何与 GitHub 交互
每个人与 GitHub 交互时都有自己独特的工作流程;你使用的界面和方法取决于你的偏好,以及哪种方式最适合你的需求。
有关与 GitHub 交互的不同方法的更多信息,以及可用工具的比较,请参阅 连接到 GitHub。
4. 在 GitHub 上写入
若要在问题和拉取请求中清晰有序地进行沟通,可以使用 Flavored Markdown 进行格式设置,该格式将 GitHub 易于阅读、易于写入的语法与一些自定义功能相结合。 有关详细信息,请参阅“关于在GitHub上撰写和格式化”。
您可以通过 GitHub 上的 使用 Markdown 进行沟通 课程学习 GitHub Skills 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 Issues 和 Projects
您可以使用 GitHub Issues 通过议题和拉取请求来组织工作,并使用 Projects 管理工作流。 有关详细信息,请参阅 关于问题 和 关于 Projects。
7. 管理通知
通知会提供有关你在 GitHub 上订阅或参与的活动的最新动态。 如果您的某项对话不再感兴趣,您可以取消订阅、取消关注或自定义以后接收的通知类型。 有关详细信息,请参阅“关于通知”。
8. 使用 GitHub Pages
可用于 GitHub Pages 直接从存储库 你的 GitHub Enterprise Server 实例创建和托管网站。 有关详细信息,请参阅“什么是 GitHub Pages?”。
9. 使用 GitHub Discussions
可以为存储库启用 GitHub Discussions ,以帮助围绕项目构建社区。 维护者、贡献者和访客可以使用讨论来共享公告、提出和回答问题,以及参与关于目标的对话。 有关详细信息,请参阅“关于讨论”。
第 4 部分:在 GitHub 上自定义并自动化你的工作
你可以使用 GitHub Marketplace 中的工具、GitHub API 以及现有的 GitHub 功能来自定义和自动化工作。
1. GitHub API 使用
GitHub API 有两个版本:REST API 和 GraphQL API。 你可以使用 GitHub API 来自动执行常见任务、备份数据或创建扩展 GitHub 的集成。 有关详细信息,请参阅“比较GitHub的 REST API 和 GraphQL API”。
2. 建筑 GitHub Actions
借助 GitHub Actions,可以在 GitHub 上自动执行并自定义企业的开发工作流。 可以创建自己的操作,以及使用和自定义 GitHub 社区分享的操作。 有关详细信息,请参阅“撰写工作流程”。
3. 发布和管理 GitHub Packages
GitHub Packages 是一种软件包托管服务,允许您私下或公开托管软件包,并将包用作项目中的依赖项。 有关详细信息,请参阅“GitHub Packages 简介”。
第 5 部分:在 GitHub 上安全地进行构建
GitHub 具有多种安全功能,可帮助在存储库中保护代码和机密。 某些功能适用于所有仓库,而其他功能仅适用于公开仓库以及带有 GitHub Code Security 或 GitHub Secret Protection 许可证的仓库。 有关安全功能的概述,请参阅 GitHub安全功能。
1. 保护存储库
作为存储库管理员,您可以通过配置存储库安全设置来保护您的存储库。 其中包括管理对存储库的访问、设置安全策略和管理依赖项。 对于公共存储库,以及具有这些功能许可证的组织拥有的专用存储库,还可以配置代码和机密扫描,以自动识别漏洞并确保不会公开令牌和密钥。
要了解可以采取哪些步骤来保护您的代码仓库,请参阅 保护存储库快速入门。
第 6 部分:参与 GitHub社区
有多种方法可以参与 GitHub 社区。 你可以参与开放源代码项目、与 GitHub Community Support 中的人员交互,或者通过 GitHub Skills 学习。
1. 参与开放源代码项目
为 GitHub 上的开源项目做出贡献可能是学习、教授你能想象到的任何技能和积累相关经验的一种有益方式。 有关详细信息,请参阅开源指南中的如何为开放源代码做出贡献。
可以在探索 GitHub 中找到基于过去的贡献、星级和其他活动的项目及合适的第一个议题的个性化建议。
2. 与 GitHub Community Support 交互
你可以与世界各地的开发者建立联系,以提出和解答问题、学习,以及直接与 GitHub 工作人员互动。 若要开始对话,请参阅“GitHub Community Support”。
3. 在GitHub上阅读关于GitHub Docs的内容
可以阅读反映当前所用 GitHub 产品的文档。 有关详细信息,请参阅“关于 GitHub Docs 的版本”。
4. 使用 GitHub Skills 学习
你可以通过 GitHub Skills 在自己的 GitHub 存储库中完成有趣、逼真的项目来学习新技能。 每门课程都是由 GitHub 社区创建并由友好的机器人教授的实践课程。
有关详细信息,请参阅“Git 和GitHub学习资源”。