Github使用教程

发布时间 2023-04-10 13:12:36作者: 让-雅克-卢梭

1. 注册Github账号

注册Github账号的步骤

  • 打开Github官网(https://github.com/)。
  • 点击右上角的“Sign up”按钮。
  • 输入用户名、邮箱地址和密码。
  • 选择账户类型,可以选择个人账户或组织账户。
  • 点击“Create account”按钮。
  • 验证邮箱地址,Github会向你的邮箱发送一封验证邮件,点击邮件中的链接完成验证。
  • 设置个人资料,包括头像、个人简介等信息。

如何设置个人信息

  • 点击头像旁边的下拉箭头,选择“Your profile”进入个人主页
  • 点击“Edit profile”按钮,进入编辑个人信息页面
  • 填写个人信息,包括姓名、公司、位置、个人简介等
  • 点击“Save”按钮保存修改

如何验证邮箱- 打开注册时填写的邮箱,查看是否收到了一封来自Github的验证邮件。

  • 打开邮件,点击邮件中的验证链接。
  • 如果验证链接无法点击,可以手动复制链接并在浏览器中打开。
  • 验证成功后,可以回到Github页面进行下一步操作。

2. 创建代码仓库

如何创建新的代码仓库

  • 打开GitHub网站,在右上角点击“+”号,选择“New repository”;
  • 在“Repository name”中输入仓库名称;
  • 可选地,在“Description”中添加仓库描述;
  • 可选地,选择仓库类型(公开或私有);
  • 可选地,选择是否自动生成README文件;
  • 可选地,选择.gitignore文件类型;
  • 可选地,选择开源许可证类型;
  • 点击“Create repository”按钮完成创建。

如何设置代码仓库的权限

  • 在代码仓库页面点击“Settings”选项卡
  • 在左侧菜单栏选择“Manage access”选项
  • 点击“Invite a collaborator”按钮,输入合作者的GitHub用户名或邮箱地址
  • 选择合适的权限级别(如Read、Write、Admin等)
  • 点击“Add [collaborator] to [repository]”按钮,完成合作者的添加

表格示例:

步骤操作
1 在代码仓库页面点击“Settings”选项卡
2 在左侧菜单栏选择“Manage access”选项
3 点击“Invite a collaborator”按钮,输入合作者的GitHub用户名或邮箱地址
4 选择合适的权限级别(如Read、Write、Admin等)
5 点击“Add [collaborator] to [repository]”按钮,完成合作者的添加

如何上传代码到仓库- 首先,在GitHub上创建一个新的代码仓库,点击页面右上角的“+”号,选择“New repository”。

  • 在弹出的页面中,填写仓库的名称、描述等信息,选择公开或私有等选项,然后点击“Create repository”按钮,创建新的代码仓库。

  • 接着,在本地电脑上创建一个文件夹,用于存放本地代码。

  • 在该文件夹中打开命令行窗口,输入以下命令,初始化Git仓库:

    git init
    
  • 然后,将本地代码添加到Git仓库中,输入以下命令:

    git add .
    

    这里的“.”表示将该文件夹中的所有文件都添加到Git仓库中。

  • 接着,提交代码到本地Git仓库中,输入以下命令:

    git commit -m "Initial commit"
    

    这里的“-m”表示添加提交信息,“Initial commit”为提交信息的内容。

  • 最后,将本地Git仓库中的代码推送到GitHub上的远程仓库中,输入以下命令:

    git remote add origin git@github.com:yourname/yourrepository.git
    git push -u origin master
    

    这里的“yourname”为你的GitHub用户名,“yourrepository”为你的代码仓库名称。

3. 分支管理

如何创建新的分支

  • 在本地创建新分支并切换到该分支:

    git checkout -b <branch_name>
    
  • 将新分支推送到远程仓库:

    git push -u origin <branch_name>
    
  • 如果需要在远程仓库创建新分支,可以使用以下命令:

    git push origin <branch_name>
    

如何合并分支

  • 假设我们有两个分支,分别是master和feature
  • 首先,切换到master分支:git checkout master
  • 然后,将feature分支合并到master分支:git merge feature
  • 如果出现冲突,需要手动解决冲突
  • 最后,将合并后的代码推送到远程仓库:git push

如何删除分支- 使用命令行删除分支:

git branch -d 分支名
  • 使用命令行强制删除分支:
git branch -D 分支名
  • 使用GitHub网页端删除分支:
    1. 进入仓库页面
    2. 点击上方的“Branch: 分支名”按钮
    3. 选择要删除的分支
    4. 点击旁边的“Delete branch”按钮
    5. 确认删除操作

4. Pull Request

Pull Request的作用

  • Pull Request的作用:
    • 在GitHub上,Pull Request是一种让开发者向项目贡献代码的方式。
    • 当你想要为一个项目做出贡献时,你可以Fork这个项目,并在你的Fork中进行修改。
    • 当你的修改完成后,你可以向原项目发起一个Pull Request,请求原项目将你的修改合并到主分支中。
    • 这样,原项目的维护者就可以审核你的修改,并将其合并到主分支中,从而使你的贡献成为项目的一部分。

如何创建Pull Request

  • 在本地创建新分支并进行修改,提交修改到该分支上。
  • 在GitHub上找到该仓库,点击“New pull request”按钮。
  • 在“Comparing changes”页面中,选择要将修改合并到的目标分支。
  • 确认修改内容,填写相关信息,点击“Create pull request”按钮。
  • 等待目标分支的维护者审核并合并该修改。

如何审核和合并Pull Request- 确认Pull Request的内容是否符合项目的要求和标准。

  • 在本地测试Pull Request的代码,确保其能够正常运行。
  • 如果需要,与Pull Request的作者进行沟通,讨论代码的修改和改进的建议。
  • 如果需要,邀请其他团队成员参与审核和讨论。
  • 在审核通过后,将Pull Request合并到主分支中。可以使用GitHub的“Merge”按钮或者命令行工具进行合并。
  • 确认合并后的代码是否能够正常运行,并及时删除已经合并的分支。

5. Issue管理

如何创建Issue

  • 在你的repository页面,点击"Issues"选项卡
  • 点击绿色的"New issue"按钮
  • 在"Title"框中输入Issue的标题
  • 在"Leave a comment"框中输入Issue的详细描述
  • 点击"Submit new issue"按钮提交Issue

如何回复和关闭Issue

  • 如何回复Issue:

    在Issue页面下方,输入回复内容并点击“Comment”即可回复该Issue。

  • 如何关闭Issue:

    在Issue页面右侧,点击“Close issue”按钮,弹出关闭Issue确认框,输入关闭原因并点击“Close issue”即可关闭该Issue。

如何使用标签和里程碑管理Issue- 使用标签管理Issue:

标签是一种用于对Issue进行分类和归档的方式,可以帮助团队更好地管理和跟踪Issue。在创建或编辑Issue时,可以为其添加标签,也可以通过搜索标签来查找相关的Issue。

例如,我们可以为一个Issue添加“bug”、“feature”、“enhancement”等标签,以便更好地区分和管理不同类型的Issue。

  • 使用里程碑管理Issue:

    里程碑是一种用于跟踪和管理项目进度的方式,可以将一组相关的Issue分配到同一个里程碑中,并设置里程碑的截止日期。在查看里程碑时,可以看到该里程碑中所有Issue的状态和进度。

    例如,我们可以创建一个里程碑“v1.0发布”,并将所有与该版本相关的Issue分配到该里程碑中,以便更好地跟踪和管理项目进度。

6. Github Pages

Github Pages的作用

  • Github Pages的作用:
    • 提供一个免费的静态网站托管服务
    • 支持自定义域名
    • 支持Jekyll静态网站生成器
    • 可以通过Github Actions自动化部署网站
    • 适合个人博客、项目文档等静态网站的搭建和发布。

如何创建Github Pages

  • 在Github上创建一个新的repository,repository的名称必须是username.github.io,其中username是你的Github用户名。
  • 在本地创建一个新的文件夹,命名为username.github.io,并进入该文件夹。
  • 在该文件夹下创建一个index.html文件,作为Github Pages的首页。
  • 将该文件夹初始化为一个Git仓库,并将其与Github上的repository关联。
  • 将本地代码推送到Github上的repository中。
  • 等待几分钟,访问http://username.github.io即可查看你的Github Pages网站。

如何自定义Github Pages的主题和样式- 在Github上找到自己喜欢的主题,例如Minimal Mistakes

  • Fork这个主题的仓库到自己的Github账号下。
  • 修改配置文件_config.yml,包括标题、描述、导航栏等。
  • 修改页面布局和样式,可以通过修改_layouts_sass文件夹下的文件实现。
  • 部署自己的Github Pages,参考官方文档

7. Github Desktop

Github Desktop的安装和配置

  • 下载Github Desktop安装包并安装
  • 打开Github Desktop,输入你的Github账号和密码
  • 配置Github Desktop的默认本地存储路径
  • 配置Git的全局变量,包括用户名和邮箱
  • 配置Github Desktop的默认编辑器,如Atom或VS Code
  • 配置Github Desktop的默认分支保护规则
  • 配置Github Desktop的默认提交信息模板
  • 配置Github Desktop的默认合并方式和策略
  • 配置Github Desktop的默认远程仓库和分支跟踪
  • 配置Github Desktop的默认Git LFS(Large File Storage)规则
  • 配置Github Desktop的默认SSH密钥

如何使用Github Desktop进行代码管理

  • 安装Github Desktop客户端
  • 登录Github账号
  • 克隆代码仓库到本地
  • 创建分支
  • 切换分支
  • 提交代码
  • 合并代码到主分支
  • 拉取最新代码
  • 解决代码冲突
  • 查看提交历史
  • 回滚代码
  • 发布代码
  • 其他高级功能(如rebase操作等)

如何使用Github Desktop进行分支管理- 在Github Desktop中,点击左上角的“Current Branch”按钮,选择“New Branch”创建新分支。

  • 在新弹出的对话框中,输入分支名称并选择基于哪个分支创建新分支。
  • 点击“Create Branch”按钮,即可创建新分支。
  • 在本地修改代码后,点击Github Desktop中的“Changes”选项卡,可以看到所有修改过的文件。
  • 勾选需要提交的文件,填写提交信息并点击“Commit to [分支名称]”按钮提交更改到当前分支。
  • 切换回主分支,点击“Merge into Current Branch”按钮,选择要合并的分支并点击“Merge Branch”按钮完成合并。
  • 如果需要推送分支到远程仓库,点击Github Desktop中的“Publish branch”按钮即可。