一、认识 GitHub

GitHub 是全球最大的代码托管与协作平台,它基于 Git 提供版本控制、代码审查、项目管理、持续集成等功能。
无论是个人开发者还是企业团队,都可以在 GitHub 上实现从编码到部署的完整流程。

一句话总结:GitHub = 代码管理 + 团队协作 + 自动化开发工作流。

核心功能包括:

  • 代码版本管理(Git 支持)

  • Pull Request 协作

  • Issue 与 Milestone 跟踪

  • Actions 自动化构建

  • Wiki 文档与项目看板


二、注册与创建仓库

  1. 打开 https://github.com(无需登录即可浏览)。

  2. 注册账户并登录。

  3. 点击右上角 New Repository 创建仓库。

配置示例:

  • Repository name:my-project

  • Description:项目描述

  • Visibility:Public(公开)或 Private(私有)

  • 勾选 “Initialize this repository with a README”

点击 Create repository 完成创建。


三、本地关联与上传代码

  1. 初始化 Git 项目:


git init

  1. 关联远程仓库:


git remote add origin https://github.com/username/my-project.git

  1. 添加文件并提交:


git add . git commit -m "首次提交"

  1. 推送到远程:


git push -u origin main


四、克隆仓库到本地


git clone https://github.com/username/my-project.git cd my-project

查看远程仓库:


git remote -v


五、分支管理

创建分支:


git branch dev

切换分支:


git checkout dev

合并分支:


git checkout main git merge dev

删除分支:


git branch -d dev

推送远程分支:


git push origin dev


六、Pull Request(代码审查流程)

  1. 在 GitHub 上新建分支并提交更改。

  2. 点击 Pull Request

  3. 填写说明(说明修改内容与目的)。

  4. 指定审核人(Reviewers)。

  5. 点击 Create Pull Request 提交。

团队成员可以:

  • Review changes 查看代码差异;

  • Approve 审核通过;

  • Request changes 请求修改;

  • Merge pull request 合并到主分支。


七、Issue 问题追踪

用于记录 Bug、功能建议、任务进度。

创建 Issue:

  • 点击 Issues → New issue

  • 填写标题与描述

  • 指定负责人(Assignee)

  • 添加标签(Labels)如 bugenhancement

  • 点击 Submit new issue

命令行关联:


git commit -m "修复登录错误 (#12)"

此提交会自动关联 Issue #12。


八、Milestone 里程碑管理

在项目周期中,可以设置目标版本或阶段目标。

创建 Milestone:

  1. 进入 Issues → Milestones → New milestone

  2. 填写标题、描述与截止日期

  3. 将相关 Issue 添加至该 Milestone

示例:
v1.0.0 → 10 个任务(8 完成 / 2 待办)


九、Labels 标签体系

为任务分类与管理添加标签。

常见标签示例:

标签 含义
bug 错误修复
feature 新功能
documentation 文档修改
help wanted 需要协助
good first issue 新手友好任务

十、README 文件编写

README 是项目的门面,需包含:


# 项目名称 ## 简介 这是一个示例项目,用于演示 GitHub 使用流程。 ## 安装 ```bash git clone https://github.com/username/my-project.git cd my-project npm install

使用


npm start

贡献

欢迎提交 Pull Request 或 Issue!


--- ### 十一、添加 LICENSE 开源协议 常用许可证类型: | 类型 | 说明 | |------|------| | MIT | 最宽松,可随意修改分发 | | GPL | 需开源衍生代码 | | Apache 2.0 | 商业友好,保护专利权 | | BSD | 简洁开源协议 | 创建许可证: ```bash touch LICENSE

或在 GitHub 新建仓库时自动生成。


十二、使用 GitHub Actions 实现自动化部署

  1. 创建工作流文件:.github/workflows/deploy.yml


name: CI/CD Pipeline on: push: branches: [ main ] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: 安装依赖 run: npm install - name: 运行测试 run: npm test - name: 部署生产 run: echo "部署完成!"

提交后,GitHub 将自动执行工作流。


十三、GitHub Pages 静态网站托管

  1. 创建分支 gh-pages

  2. 上传 HTML 文件至该分支。

  3. 进入仓库 Settings → Pages

  4. 选择 gh-pages 分支并保存。

访问:


https://username.github.io/my-project/


十四、Wiki 项目文档

点击 Wiki → Create the first page
可使用 Markdown 编写项目手册、开发文档。

示例内容:


# 开发指南 - 克隆项目 - 安装依赖 - 提交规范


十五、GitHub Projects 项目看板

在仓库中选择 Projects → New Project
模式:

  • Kanban(看板)

  • Table(任务表)

列示例:

  • To Do(待办)

  • In Progress(进行中)

  • Done(已完成)

每个 Issue 可拖拽到不同列实现任务流转。


十六、GitHub CLI(命令行工具)

安装:


sudo apt install gh -y

登录:


gh auth login

创建仓库:


gh repo create my-new-repo --public

查看 Issue:


gh issue list

参考案例:www.iulfcu.cn


十七、团队协作与权限管理

Settings → Collaborators 添加协作者。

角色:

  • Admin:拥有完全控制权。

  • Maintainer:管理分支、合并 PR。

  • Contributor:贡献代码。

  • Viewer:只读访问。


十八、分支保护策略

设置主分支保护:

  • 禁止直接推送;

  • 要求通过 Pull Request;

  • 启用代码审查;

  • 强制 CI 通过。

路径:
Settings → Branches → Add rule → Protect main branch


十九、常见 GitHub 技巧

  • 快速编辑文件:按 . 打开在线 VS Code 编辑器。

  • 关闭 Issue:在提交信息中添加 fixes #ID

  • 快速搜索:

    
      

    is:issue is:open label:bug repo:username/my-project


二十、完整实战项目:团队协作开发流程

场景:

一个三人团队共同开发“任务管理系统”。

步骤:
  1. 创建仓库 task-manager,添加三名协作者。

  2. 建立开发分支:

    
      

    git branch feature-auth git branch feature-ui git branch feature-api

  3. 每人开发自己的模块并推送分支。

  4. 提交 Pull Request → 代码审查 → Merge 到主分支。

  5. GitHub Actions 自动运行测试与部署。

  6. 使用 Projects 看板跟踪任务进度。

  7. 每周生成 Milestone 总结报告。

完成后,项目形成了完整的:

  • Git 分支管理

  • 团队代码审查

  • 自动化部署

  • 项目进度跟踪

Logo

这里是“一人公司”的成长家园。我们提供从产品曝光、技术变现到法律财税的全栈内容,并连接云服务、办公空间等稀缺资源,助你专注创造,无忧运营。

更多推荐