返回杭电百科

Github使用指北

作者：09

Github是一个基于Git的代码托管平台，提供了版本控制和协作功能，使开发者能够更高效地管理和分享代码。无论你是个人开发者还是团队成员，Github都能帮助你更好地组织和协作项目。

基本概念

  • Repository（仓库）：一个项目的存储空间，可以包含代码、文档、图片等文件。
  • Branch（分支）：在仓库中创建的独立开发线，可以同时进行多个功能的开发。
  • Commit（提交）：对代码或文件的更改记录，每次提交都会生成一个唯一的ID。
  • Pull Request（拉取请求）：当你完成一个功能开发后，可以创建一个拉取请求，向主分支提交你的更改，等待项目维护者审核和合并。
  • Fork（分叉）：复制一个仓库到你的账户下，允许你在不影响原仓库的情况下进行修改和开发。

进阶概念

  • Star（星标）：用户可以给喜欢的仓库添加星标，以便快速访问和表示对项目的支持。
  • Issue（问题）：用于跟踪项目中的任务、错误或功能请求，可以分配给团队成员并设置标签。
  • Actions（操作）：Github提供的持续集成和持续部署工具，可以自动化构建、测试和部署流程。
  • Wiki（维基）：为项目提供一个文档平台，可以用来编写项目的使用说明、开发指南等文档。

基本操作

1. 创建仓库：登录或者注册GitHub，点击右上角的“New repository”按钮，填写仓库名称和描述，选择公开或私有，然后点击“Create repository”。

2. 克隆仓库：在仓库页面，点击“Code”按钮，复制仓库的URL，在终端中使用git clone <repository-url>命令将仓库克隆到本地。

3. 创建分支：在终端中使用git checkout -b <branch-name>命令创建并切换到一个新的分支。

4. 提交更改：在本地修改文件后，使用git add <file>命令将更改添加到暂存区，然后使用git commit -m "commit message"命令提交更改。

5. 推送分支：使用git push origin <branch-name>命令将分支推送到远程仓库。

6. 创建拉取请求：在GitHub上，进入你的分支页面，点击“New pull request”按钮，选择要合并的分支和目标分支，填写拉取请求的标题和描述，然后点击“Create pull request”。

7. 合并拉取请求：项目维护者审核拉取请求后，可以选择合并到主分支，或者请求修改后再合并。

Best Practices

#### 创建你的第一个仓库、修改文件、创建分支、提交更改、创建拉取请求并合并更改

1. 创建仓库：登录GitHub，点击右上角的“New repository”按钮，填写仓库名称和描述，选择公开或私有，选择添加README.md，然后点击“Create repository”。

2. 修改文件：当你创建了仓库后，应该会转调到仓库主页。点击README.md文件，点击编辑按钮（铅笔图标），在文本框中输入一些内容，例如“这是我的第一个GitHub仓库”，然后点击“Commit changes”按钮然后提交更改。这就完成了你的第一次文件修改和提交。

3. 创建分支：在仓库主页，点击“Branch: main”按钮，在输入框中输入新的分支名称，例如“feature-branch”，然后按回车键创建分支。这就完成了分支的创建。

4. 切换分支：在仓库主页，点击“Branch: main”按钮，在下拉菜单中选择你刚才创建的分支“feature-branch”，点击切换到该分支。这就完成了分支的切换。

5. 提交更改：在“feature-branch”分支上，点击README.md文件，点击编辑按钮（铅笔图标），在文本框中输入一些内容，例如“这是我的第一个分支”，然后点击“Commit changes”按钮提交更改。这就完成了在分支上修改文件并提交更改。

6. 创建拉取请求：在仓库主页，点击“Pull requests”标签页，然后点击“New pull request”按钮。在“Compare changes”页面，选择你刚才创建的分支“feature-branch”作为比较分支，选择“main”作为基准分支，然后点击“Create pull request”按钮。在拉取请求页面，填写标题和描述，例如“添加了新的功能”，然后点击“Create pull request”按钮提交拉取请求。这就完成了拉取请求的创建。

7. 合并拉取请求：在拉取请求页面，点击“Merge pull request”按钮，然后点击“Confirm merge”按钮确认合并。这就完成了拉取请求的合并。

#### 在本地修改文件并提交更改

1. 克隆仓库：在仓库页面，点击“Code”按钮，复制仓库的URL，在终端中使用git clone <repository-url>命令将仓库克隆到本地。

2. 切换分支：在终端中使用git checkout <branch-name>命令切换到你想要修改的分支。

3. 修改文件：使用文本编辑器打开你想要修改的文件，进行修改并保存。

4. 提交更改：在终端中使用git add <file>命令将更改添加到暂存区，然后使用git commit -m "commit message"命令提交更改。

5. 推送更改：使用git push origin <branch-name>命令将更改推送到远程仓库。

6. 创建拉取请求：在GitHub上，进入你的分支页面，点击“New pull request”按钮，选择要合并的分支和目标分支，填写拉取请求的标题和描述，然后点击“Create pull request”按钮提交拉取请求。

7. 合并拉取请求：项目维护者审核拉取请求后，可以选择合并到主分支，或者请求修改后再合并。

#### 处理别人的拉取请求

1. 查看拉取请求：在仓库主页，点击“Pull requests”标签页，查看所有的拉取请求。

2. 审核拉取请求：点击一个拉取请求，点击“Files changed”标签页，查看更改的文件和代码，检查是否符合项目的要求和规范。

3. 发表评论：如果你有意见或建议，可以在代码行上点击加号图标，输入你的评论，然后点击“Start a review”按钮开始审核，或者点击“Add single comment”按钮添加单条评论。

4. 请求修改：如果你认为拉取请求需要修改，可以点击“Request changes”按钮，填写修改意见，然后点击“Submit review”按钮提交审核。

5. 批准拉取请求：如果你认为拉取请求没有问题，可以点击“Approve”按钮，填写批准意见，然后点击“Submit review”按钮提交审核。

6. 合并拉取请求：如果你是项目维护者，并且认为拉取请求没有问题，可以点击“Merge pull request”按钮，然后点击“Confirm merge”按钮确认合并。这就完成了拉取请求的合并。

#### 处理合并冲突

问AI吧，这样最快

Summary

Github是一个非常强大的开源社区，如果你有兴趣参与开源项目或者想要更好地管理自己的代码，Github是一个非常好的选择。通过以上的步骤，你可以轻松地创建仓库、修改文件、创建分支、提交更改、创建拉取请求并合并更改。同时，Github还提供了许多其他功能，例如Issue跟踪、Actions自动化等，可以帮助你更好地管理和协作项目。

如果你的开源项目做的很好，很有可能会有猎头或者一些公司来找你，提供一些工作机会或者合作机会。所以，积极参与开源社区也是一个很好的职业发展途径。我就收到过猎头的邮件，邀请我去面试一些公司，都是因为我在Github上有一些开源项目和贡献。

总的来说，Github是一个简单且强大的网站，适合个人和团队进行代码管理和协作。通过以上步骤，你可以轻松地创建仓库、修改文件、创建分支、提交更改、创建拉取请求并合并更改。希望这个指北能帮助你更好地使用Github！