跳至主要内容

仓库快速入门

了解如何在 5 分钟内创建新仓库并提交你的第一次更改。

创建仓库

GitHub 仓库存放各种项目。在本指南中,你将创建一个仓库并提交你的第一次更改。

  1. 在任意页面的右上角,选择,然后点击 新建仓库

    Screenshot of a GitHub dropdown menu showing options to create new items. The menu item "New repository" is outlined in dark orange.

  2. 为你的仓库输入一个简短且易记的名称。例如,"hello-world”。

    Screenshot of the first step in creating a repository. The "Repository name" field contains the text "hello-world" and is outlined in dark orange.

  3. 可选地,添加仓库的描述。例如,"我的第一个 GitHub 仓库”。

  4. 选择仓库可见性。欲了解更多信息,请参阅 关于仓库

  5. Add README 切换为 On

  6. 点击 创建仓库

恭喜!你已成功创建第一个仓库,并用 README 文件完成初始化。

注意

要了解更多关于 GitHub CLI 的信息,请参阅 关于 GitHub CLI

  1. 在命令行中,导航到你想要为新项目创建本地克隆的目录。
  2. 要为你的项目创建仓库,请使用 gh repo create 子命令。出现提示时,选择 在 GitHub 上从头创建一个新仓库 并输入新项目的名称。如果希望项目归属于组织而非个人账号,请使用 organization-name/project-name 指定组织名称和项目名称。
  3. 按照交互式提示操作。当询问是否要克隆远程项目目录时,确认 “是”,即可在本地克隆仓库。
  4. 或者,为跳过提示,可直接提供仓库名称和可见性标志(--public--private--internal)。例如,gh repo create project-name --public。若要在本地克隆仓库,请添加 --clone 标志。有关可用参数的更多信息,请参阅 GitHub CLI 手册

提交你的第一次更改

一次 提交 类似于在特定时间点对项目所有文件的快照。

当你创建新仓库时,你已经用一个 README 文件完成初始化。README 文件是详细描述项目或添加文档(例如安装或使用方法)的绝佳位置。README 文件的内容会自动显示在仓库的首页。

让我们对 README 文件提交一次更改。

  1. 在仓库文件列表中,选择 README.md

    Screenshot of a list of files in a repository. A file name, "README.md", is highlighted with an orange outline.

  2. 在文件视图的右上角,点击以打开文件编辑器。

    Screenshot of a file. In the header, a button, labeled with a pencil icon, is outlined in dark orange.

  3. 在文本框中输入一些关于你自己的信息。

  4. 在新内容上方,点击 预览

    Screenshot of a file in edit mode. Above the file's contents, a tab labeled "Preview" is outlined in dark orange.

  5. 审阅你对文件所做的更改。如果选择 Show diff,新内容将以绿色显示。

    Screenshot of a file preview. The "Show diff" checkbox is enabled and additions to the file are shown with a green line. Both are outlined in orange.

  6. 点击 提交更改...

  7. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  8. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  9. 点击 提交更改提议更改

既然你已经创建了项目,就可以开始提交更改了。

README 文件是更详细描述项目或添加文档(例如安装或使用方法)的绝佳位置。README 文件的内容会自动显示在仓库的首页。请按以下步骤添加 README 文件。

  1. 在命令行中,导航到新项目的根目录。(该目录是在运行 gh repo create 命令时创建的。)

  2. 创建一个包含项目信息的 README 文件。

    echo "info about this project" >> README.md
    
  3. 输入 git status。你会看到有一个未跟踪的 README.md 文件。

    $ git status
    
    Untracked files:
      (use "git add <file>..." to include in what will be committed)
      README.md
    
    nothing added to commit but untracked files present (use "git add" to track)
    
  4. 暂存并提交该文件。

    git add README.md && git commit -m "Add README"
    
  5. 将更改推送到你的分支。

    git push --set-upstream origin HEAD
    

后续步骤

你已经创建了一个仓库(包括 README 文件),并在 GitHub 上完成了第一次提交。

  • 现在,你可以克隆 GitHub 仓库,在电脑上创建本地副本。通过本地仓库,你可以提交更改,并创建 Pull Request 将更改推送到上游仓库。欲了解更多信息,请参阅 克隆仓库设置 Git
  • 使用 GitHub 提供的安全功能来保护你的仓库。欲了解更多信息,请参阅 仓库安全快速入门

  • 你可以在 GitHub 上寻找有趣的项目和仓库,并通过创建该仓库的 Fork 来进行修改。Fork 仓库能够让你在不影响原始仓库的情况下进行更改。欲了解更多信息,请参阅 Fork 仓库

  • GitHub 上的每个仓库都归个人或组织所有。你可以通过在 GitHub 上关注并关联这些人、仓库和组织来进行互动。更多信息,请参阅 在 GitHub 上寻找灵感

  • GitHub 拥有活跃的支持社区,你可以在这里寻求帮助并与来自全球的人交流。加入 GitHub Community 的讨论吧。

© . This site is unofficial and not affiliated with GitHub, Inc.