github仓库使用

一、仓库建立

  1. 在登录后进入仓库创建界面,填写仓库名称和描述即可创建仓库
    创建仓库

  2. 仓库主页的功能介绍

    • 修改项目介绍,点击edit
    • 查看仓库名称,一般情况仓库名称即为项目名称
    • Create new file创建文件、upload files上传文件、Find file搜索仓库文件
    • Clone or Download直接下载或通过github克隆
    • 点击事务卡片issu可以新建issu,在发现代码bug,但是目前没有成型代码需要讨论时使用。
      项目界面

二、仓库管理

  1. 新建文件

    • 点击create new file新建文件
    • 进入后填写文件名称和文件内容
    • 填写每次提交的目的和描述,为了方便其他开发者知道本次添加或修改的原因
    • 点击Commit new file 即可提交
  2. 编辑文件

    • 点击文件名到文件详情页可以做删除和修改动作
    • 点击文件描述可以查看该文件提交的详细信息
    • 点击修改符号进行修改文件
    • 填写修改的目的和具体描述
    • 点击Commit new file 即可提交
  3. 删除文件

    • 点击文件名进入文件详情页
    • 点击删除按钮删除文件
    • 填写修改的目的和具体描述
    • 点击Commit new file 即可提交
    • 删除后可点击commits查看已经删除的文件
  4. 上传文件

    • 点击upload files即可选择上传文件
    • 填写修改的目的和具体描述
    • 点击Commit new file 即可提交
  5. 搜索仓库文件

    • 点击Go to file可以搜索文件
    • 同时支持快捷键(t/T)

三、Github issues

  1. 作用:发现代码bug,但是目前没有成型代码,需要讨论时用;或者使用开源项目出现问题时使用。
  2. 提出方与代码拥有着均有关闭issue的权限
  3. pull request
    • fork项目
    • 修改自己仓库的项目代码
    • 新建pull request
    • 等待作者审核并合并修改

四、github 从本地上传文件

  1. 上传文件到主分支,
    1
    2
    3
    4
    5
    6
    7
    git init //初始化仓库
    git add . //添加文件到本地仓库
    git branch -M main //选择main分支,可以改名上传其它分支
    git commit -m "first commit" //添加文件描述信息
    git remote add origin https://github.com/xxx/xxxx.git //链接远程仓库,创建主分支
    git pull origin main // 把本地仓库的变化连接到远程仓库主分支
    git push -u origin main //此处上传的是main分支
  2. 若上传失败,可以使用强制上传,上传后会完全覆盖代码,谨慎使用
    1
    git push -f origin main //强制push就成功了。

五、Git安装使用

  1. 下载并安装

  2. Git工作区域

    • 工作区(Working Directory)、暂存区、Git仓库(Git Repsitory)
      Git工作区域示意图

    • git的基本流程命令

      git基本流程

  3. 命令行控制

    • git status 查看当前文件的状况
    • git add 将文件从工作区提交到暂存区
    • git commit -m "提交描述" 填写描述,文件从暂存区提交到本地仓库
    • git push 将本地仓库文件提交到远程仓库
    • git init 初始化仓库
    • git config --global user.name 'username' 初始化填写用户名
    • git config --global user.email 'email@qq.com' 初始化填写邮箱 这会用于github主页显示提交用户
    • git clone 仓库地址 从远程仓库克隆到本地
    • git config --list 检查自己的设置

六、利用github搭建个人网站

  1. 访问https://个人用户名.github.io
  2. 搭建个人网站步骤
    • 创建个人站点
    • 新建仓库(仓库名必须是【用户名.github.io】)
    • 在仓库下新建index.html文件即为网站主页

七、git仓库的基本命令

  1. git项目搭建
    • 本地创库创建 git init
    • 从远程仓库获取项目git clone url
  2. 正常工作流
    • git status 查看仓库文件状态
    • git add . 添加文件到暂存区
    • git commit -m "描述信息" 提交暂存区的内容到本地仓库 -m 提交信息
    • git push 提交到远程 ,git push origin master 指定切换到master分支提交
  3. 忽略文件:有些文件不需要纳入到版本控制中,比如数据库文件,临时文件,设计文件
    • 在主目录下建立“.gitignore”文件,此文件有如下规则
      • 忽略文件中的空行或以井号(#)开始的行会被忽略。
      • 可以使用Linux通配符。例如(*)代表任意多个字符,问好(?)代表一个字符,方括号([abc])代表可选字符规范,大括号 ({string1,string2,…})代表可选字符串等。
      • 如果名称的最前面有一个感叹号(!),表示例外规则,将不被忽略。
      • 如果名称最前面有一个路径分割符(/),表示要忽略的文件在此目录下,而子目录中的文件不忽略。
      • 如果名称的最后面一个路径分割符(/),表示忽略的是此目录下该名称的子目录,而非文件(默认文件或目录都被忽略)
        1
        2
        3
        4
        5
        *.txt    #忽略所有 .txt 结尾的文件,这样的话上传就不会被选中
        !lib.txt #结合前面描述,但 lib.txt 除外,不被忽略
        /temp # 仅忽略项目根目录下的TODO文件,不包括其他目录temp文件
        build/ # 忽略 build/ 目录下的所有文件
        doc/* .txt # 会忽略 doc/note.txt 但不会忽略 doc/server/arch.txt
  4. 生成公钥实现免密码登录
    • 在电脑 C/用户/admin/.ssh目录下
    • 使用命令 ssh-keygen -t rsa 生成公钥
    • 把公钥粘贴到远程代码仓库的对应位置

八、Git分支

  1. git分支中的常用命令
    • 列出所有的本地分支 git branch
    • 了出所有的远程分支 git branch -r
    • 新建一个分支,但仍保留在当前分支 git branch [branch-name]
    • 新建一个分支,并切换到新建的分支上 git checkout -b [branch]
    • 合并指定分支到当前分支 git merge [branch]
    • 删除分支 git branch -d [branch-name]
    • 删除远程分支 git push origin --delete [branch-name]或者git branch -dr [remote/branch]
    • 建立本地到远端仓库的链接 git push --set-upstream origin dev //dev为创建分支的名字
    • 设置本地分支追踪远程分支 git push --set-upstream origin main main为分支名