GitHub 是一个面向开源及私有软件项目的托管平台,因为只支持 Git 作为唯一的版本库格式进行托管,故名 GitHub。它不仅是代码仓库,还是一个强大的协作工具。本文将介绍一些 GitHub 的基本使用方法。
准备工作:安装 Git
在开始使用 GitHub 之前,你的电脑上需要安装 Git。Git 是一个免费、开源的分布式版本控制系统,是与 GitHub 交互的基础。
你可以从 Git 官网 下载适合你操作系统的安装包。安装过程通常很简单,保持默认设置即可。
安装完成后,你可以在终端(Windows 上的 PowerShell 或 CMD,macOS/Linux 上的 Terminal)中输入以下命令来验证 Git 是否安装成功:
git --version
如果能看到版本号,说明 Git 已经成功安装。
核心概念
在开始使用 GitHub 之前,了解一些核心概念非常重要:
- 仓库 (Repository): 你的项目存放的地方。可以想象成一个项目的文件夹,里面包含了项目的所有文件和修订历史。
- 克隆 (Clone): 将远程仓库复制到你的本地计算机上。
- 提交 (Commit): 将你的代码更改保存到本地仓库。每次提交都有一个唯一的 ID 和一条描述信息。
- 推送 (Push): 将本地仓库的提交上传到远程仓库(例如 GitHub)。
- 拉取 (Pull): 从远程仓库获取最新的更改并合并到你的本地仓库。
- 分支 (Branch): 为了在不影响主线(通常是
main或master分支:这几年估计都改成了main,说是master有奇怪的隐喻😅)开发的情况下进行功能开发或修复 bug,你可以创建一个分支。开发完成后,再将分支合并到主线。 - 拉取请求 (Pull Request / PR): 当你希望将你的分支合并到另一个分支时,你可以创建一个拉取请求。这是一个请求审查和讨论你的代码更改的地方。
- 合并 (Merge): 将一个分支的更改合并到另一个分支。
基本工作流程
1. 创建一个新的仓库
- 登录你的 GitHub 账户。
- 点击右上角的 “+” 图标,然后选择 “New repository”。
- 为你的仓库命名,添加一个可选的描述。
- 选择 “Public”(公开)或 “Private”(私有)。
- 你可以选择使用
README文件、.gitignore文件和许可证来初始化仓库。 - 点击 “Create repository”。
2. 克隆仓库到本地
要对仓库进行更改,你需要先把它克隆到你的电脑上。
git clone https://github.com/your-username/your-repository.git
将 your-username 和 your-repository 替换为你的 GitHub 用户名和仓库名。
3. 添加和提交更改
在本地对项目文件进行修改后,你需要将这些更改提交到本地仓库。
# 进入仓库目录
cd your-repository
# 查看文件状态
git status
# 添加所有更改的文件到暂存区
git add .
# 提交更改,并附上描述信息
git commit -m "你的提交信息,例如:添加了新功能"
4. 推送更改到 GitHub
提交到本地仓库后,你需要将这些更改推送到 GitHub 上的远程仓库。
git push origin main
(main 可能是你的主分支名,也可能是 master)
分支与协作
分支是 GitHub 协作的核心。
1. 创建并切换到新分支
# 创建一个名为 feature-x 的新分支并切换过去
git checkout -b feature-x
2. 推送新分支到 GitHub
在你的新分支上进行提交后,将该分支推送到远程仓库。
git push origin feature-x
3. 创建拉取请求 (Pull Request)
- 在 GitHub 上你的仓库页面,你会看到一个提示,可以为
feature-x分支创建一个拉取请求。 - 点击 “Compare & pull request”。
- 填写标题和描述,说明你的更改内容。
- 点击 “Create pull request”。
之后,项目维护者可以审查你的代码,提出修改意见,最后将其合并到主分支中。
GitHub Pages
GitHub Pages 是 GitHub 提供的一个静态网站托管服务。你可以用它来托管你的个人博客、项目文档等。
- 确保你的仓库中有一个
index.html文件。 - 进入仓库的 “Settings” 页面。
- 在左侧菜单中选择 “Pages”。
- 在 “Source” 部分,选择你想要部署的分支(通常是
main)。 - 保存后,GitHub 会为你的网站生成一个 URL,格式通常是
https://your-username.github.io/your-repository/。
希望这篇指南能帮助你更好地开始使用 GitHub!