跳至主要内容

使用 GitHub Desktop 创建你的第一个仓库

你可以使用 GitHub Desktop 创建和管理 Git 仓库,无需使用命令行。

简介

GitHub Desktop 是一款免费的开源应用程序,可帮助你使用托管在 GitHub 或其他 Git 托管服务上的代码。使用 GitHub Desktop,你可以在图形用户界面中执行 Git 命令(例如提交和推送更改),而不是使用命令行。有关更多信息,请参阅“关于 GitHub Desktop”。

在本指南结束时,你将已经使用 GitHub Desktop 创建了一个仓库,对仓库进行了更改,并将更改发布到了 GitHub。

安装 GitHub Desktop 并登录 GitHub 或 GitHub Enterprise 后,你可以创建和克隆一个教程仓库。本教程将介绍使用 Git 和 GitHub 的基础知识,包括安装文本编辑器、创建分支、进行提交、推送到 GitHub 以及打开拉取请求。如果你在 GitHub Desktop 上没有任何仓库,则可以使用本教程。

我们建议完成本教程,但如果你想通过创建一个新的仓库来探索 GitHub Desktop,本指南将引导你使用 GitHub Desktop 处理 Git 仓库。

第一部分:安装 GitHub Desktop 并验证你的帐户

你可以在任何支持的操作系统上安装 GitHub Desktop。安装应用程序后,你需要在 GitHub 或 GitHub Enterprise 上登录并验证你的帐户,然后才能创建和克隆教程仓库。

有关安装和验证的更多信息,请参阅“设置 GitHub Desktop”。

第二部分:创建新的仓库

如果你没有与 GitHub Desktop 关联的任何仓库,你将看到“让我们开始!”视图,你可以在其中选择创建和克隆教程仓库、从互联网克隆现有仓库、创建新仓库或添加来自硬盘的现有仓库。

Screenshot of the "Let's get started!" view in GitHub Desktop.

创建和克隆教程仓库

我们建议你将创建和克隆教程仓库作为你的第一个项目,以练习使用 GitHub Desktop。

  1. 点击**创建教程仓库...**。
  2. 按照教程中的提示安装文本编辑器、创建分支、编辑文件、进行提交、发布到 GitHub 并打开拉取请求。

创建新的仓库

如果你不想创建和克隆教程仓库,可以创建一个新的仓库。

  1. 点击**在你的硬盘上创建一个新仓库...**。
  2. 在“创建新仓库”窗口中,填写字段并选择你喜欢的选项。
    • “名称”定义了你的仓库在本地和 GitHub 上的名称。
    • “描述”是一个可选字段,你可以用来提供有关仓库用途的更多信息。
    • “本地路径”设置仓库在计算机上的位置。默认情况下,GitHub Desktop 会在你的“文档”文件夹内创建一个名为 *GitHub* 的文件夹来存储你的仓库,但你可以在计算机上选择任何位置。你的新仓库将成为所选位置内的文件夹。例如,如果你将仓库命名为 `Tutorial`,则会在你为本地路径选择的文件夹内创建一个名为 *Tutorial* 的文件夹。GitHub Desktop 会记住你选择的路径,以便你在下次创建或克隆新仓库时使用。
    • **使用自述文件初始化此仓库** 会使用 *README.md* 文件创建一个初始提交。自述文件可以帮助人们理解你的项目的目的,因此我们建议你选择此选项并填写有用的信息。当有人在 GitHub 上访问你的仓库时,自述文件是他们了解你的项目时首先看到的内容。有关更多信息,请参阅“关于自述文件”。
    • **Git ignore** 下拉菜单允许你添加一个自定义文件,以忽略本地仓库中你不想存储在版本控制中的特定文件。如果你将使用某种特定的语言或框架,你可以从可用列表中选择一个选项。如果你只是刚刚开始,可以随意跳过此选择。有关更多信息,请参阅“忽略文件”。
    • **许可证** 下拉菜单允许你向仓库中的 LICENSE 文件添加开源许可证。你无需立即添加许可证。有关可用开源许可证以及如何将它们添加到你的仓库的更多信息,请参阅“许可仓库”。
  3. 点击**创建仓库**。

第三部分:探索 GitHub Desktop

在屏幕顶部的文件菜单中,您可以访问 GitHub Desktop 中可执行的设置和操作。大多数操作也有键盘快捷键,可以帮助您更高效地工作。有关键盘快捷键的完整列表,请参阅“GitHub Desktop 键盘快捷键”。

GitHub Desktop 代码库栏

在 GitHub Desktop 应用程序顶部,您会看到一个显示代码库当前状态的栏。

Screenshot of the GitHub Desktop app. A bar displaying details for the "hello-world" repository spans the top of the window, and is outlined in orange.

  • **当前代码库**显示您正在使用的代码库的名称。您可以单击**当前代码库**以切换到 GitHub Desktop 中不同的代码库。
  • **当前分支**显示您正在使用的分支的名称。您可以单击**当前分支**以查看代码库中的所有分支,切换到不同的分支或创建新的分支。在代码库中创建拉取请求后,您也可以通过单击**当前分支**来查看这些请求。
  • 由于您尚未将代码库发布到 GitHub,因此会显示**发布代码库**,您将在下一步中执行此操作。此栏的此部分将根据当前分支和代码库的状态而改变。将提供不同的上下文相关操作,让您可以在本地和远程代码库之间交换数据。

更改和历史记录

在左侧边栏中,您会找到**更改**和**历史记录**视图。

Screenshot of the GitHub Desktop app. A sidebar on the left-hand side, with tabs labeled "Changes" and "History", is highlighted with an orange outline.

  • **更改**视图显示您对当前分支中的文件所做的更改,但尚未提交到本地代码库。底部有一个包含“摘要”和“描述”文本框以及**提交到 BRANCH**按钮的框。您将在此处提交新的更改。**提交到 BRANCH**按钮是动态的,它将显示您正在将更改提交到的分支。
  • **历史记录**视图显示代码库当前分支上的先前提交。您应该会看到 GitHub Desktop 在您创建代码库时创建的“初始提交”。在提交的右侧,根据您在创建代码库时选择的选项,您可能会看到 * .gitattributes*、*.gitignore*、LICENSE 或 README 文件。您可以单击每个文件以查看该文件的差异,即对该文件中所做的更改。差异仅显示文件已更改的部分,而不是文件的全部内容。

第四部分:将您的代码库发布到 GitHub

当您创建一个新的代码库时,它只存在于您的计算机上,并且只有您可以访问该代码库。您可以将代码库发布到 GitHub,以便在多台计算机之间保持同步并允许其他人访问它。要发布您的代码库,请将您的本地更改推送到 GitHub。

  1. 在代码库栏中,单击**发布代码库**。
    Screenshot of the repository bar. A button, labeled "Publish repository", is highlighted with an orange outline.
  2. 在“发布代码库”窗口中,输入新代码库的详细信息。
    • GitHub Desktop 会自动使用您在创建代码库时输入的信息填充“名称”和“描述”字段。
    • **保持此代码私有**允许您控制谁可以查看您的项目。如果您取消选中此选项,GitHub 上的其他用户将能够查看您的代码。如果您选中此选项,您的代码将不会公开。
    • 如果存在**组织**下拉菜单,则允许您将代码库发布到您在 GitHub 上所属的特定组织。
    1. 单击**发布代码库**。
    2. 您可以从 GitHub Desktop 内访问 GitHub 上的代码库。在文件菜单中,单击**代码库**,然后单击**在 GitHub 上查看**。这将直接带您到默认浏览器中的代码库。

第五部分:进行、提交和推送更改

现在您已经创建并发布了代码库,您可以开始更改项目并开始创建对代码库的第一次提交。

  1. 要在 GitHub Desktop 中启动外部编辑器,请在“GitHub Desktop”菜单栏中选择**代码库**,然后单击**在编辑器中打开**。有关更多信息,请参阅“在 GitHub Desktop 中配置默认编辑器”。

    Screenshot of a menu bar on a Mac. Under the open "Repository" dropdown menu, a cursor hovers over "Open in Visual Studio Code", highlighted in blue.

  2. 对您之前创建的 *README.md* 文件进行一些更改。您可以添加描述项目的信息,例如它的作用以及为什么它有用。当您对更改满意后,请在文本编辑器中保存它们。

  3. 在 GitHub Desktop 中,导航到**更改**视图。在文件列表中,您应该会看到您的 *README.md*。*README.md* 文件左侧的复选框表示您对文件所做的更改将成为您进行的提交的一部分。将来,您可能会对多个文件进行更改,但只想提交对某些文件所做的更改。如果您单击文件旁边的复选框,则该文件将不包含在提交中。

    Screenshot of the "Changes" tab in the sidebar. To the left of the "README.md" file, a selected checkbox is highlighted with an orange outline.

  4. 在**更改**列表底部,输入提交消息。在您的个人资料图片右侧,键入提交的简短描述。由于我们正在更改 *README.md* 文件,“添加有关项目目的的信息”将是一个很好的提交摘要。在摘要下方,您会看到一个“描述”文本字段,您可以在其中键入提交中更改的更长描述,这在回顾项目的历史记录并了解更改原因时非常有用。由于您正在对 *README.md* 文件进行基本更新,因此您可以跳过描述。

    Screenshot of the "Changes" tab in the sidebar. To the right of a profile picture, a text field containing a commit message is outlined in orange.

  5. 在提交消息下方,单击**提交到 BRANCH 名称**。提交按钮显示您当前的分支,因此您可以确保提交到所需的分支。

  6. 要将更改推送到 GitHub 上的远程代码库,请单击**推送 origin**。

    Screenshot of the "Repository" menu bar. A button, labeled "Push origin", is highlighted with an orange outline.

    • **推送 origin**按钮与您单击将代码库发布到 GitHub 的按钮相同。此按钮会根据您在 Git 工作流中的位置上下文更改。现在它应该显示 `Push origin`,旁边有一个 `1`,表示有一个提交尚未推送到 GitHub。
    • **推送 origin**中的“origin”表示您正在将更改推送到名为 `origin` 的远程端,在本例中为 GitHub 上的项目代码库。在您将任何新的提交推送到 GitHub 之前,您的计算机上的项目代码库与 GitHub 上的项目代码库之间都会存在差异。这允许您在本地工作,并且只有在准备好时才将更改推送到 GitHub。
  7. 在**更改**视图右侧的窗口中,您会看到有关您可以执行的下一步操作的建议。要在浏览器中打开 GitHub 上的代码库,请单击**在 GitHub 上查看**。

    Screenshot of the "No local changes" screen. In a list of suggestions, a button, labeled "View on GitHub", is highlighted with an orange outline.

  8. 在浏览器中,单击**2 次提交**。您将在 GitHub 上看到此代码库中提交的列表。第一次提交应该是您刚刚在 GitHub Desktop 中进行的提交。

    Screenshot of the repository page on GitHub. Above the list of files and next to a clock icon, a link, labeled "2 commits", is outlined in orange.

结论

您现在已经创建了一个代码库,将代码库发布到 GitHub,进行了一次提交,并将更改推送到 GitHub。在参与您创建或协作的其他项目时,您可以遵循相同的流程。

进一步阅读