Gitee平台使用指南
1. Gitee简介
什么是Gitee
Gitee(码云)是开源中国(OSChina)推出的基于Git的代码托管平台,是国内最大的代码托管平台之一。
Gitee的优势
- 国内访问速度快:服务器位于国内,访问速度优于GitHub
- 中文界面:提供完整的中文界面和文档
- 免费私有仓库:提供免费的私有仓库服务
- 企业级功能:支持企业级项目管理
- 丰富的集成:支持多种开发工具和CI/CD集成
与GitHub的对比
特性 | Gitee | GitHub |
---|---|---|
服务器位置 | 国内 | 国外 |
访问速度 | 快 | 较慢 |
界面语言 | 中文 | 英文 |
私有仓库 | 免费 | 付费 |
企业功能 | 丰富 | 基础 |
2. 注册与配置
注册账号
- 访问 gitee.com
- 点击"注册"按钮
- 填写用户名、邮箱、密码
- 验证邮箱完成注册
配置SSH密钥
# 生成SSH密钥
ssh-keygen -t rsa -C "你的邮箱@example.com"
# 查看公钥内容
cat ~/.ssh/id_rsa.pub
添加SSH密钥到Gitee
- 登录Gitee
- 点击右上角头像 → 设置
- 左侧菜单选择"SSH公钥"
- 点击"添加公钥"
- 粘贴公钥内容并保存
测试SSH连接
ssh -T git@gitee.com
3. 仓库管理
创建仓库
- 登录Gitee
- 点击右上角"+"号 → “新建仓库”
- 填写仓库信息:
- 仓库名称
- 仓库介绍
- 是否公开
- 是否初始化README
- 点击"创建"
仓库设置
- 基本信息:修改仓库名称、描述
- 分支管理:设置默认分支、保护分支
- 成员管理:添加协作者
- WebHook:配置自动化触发
4. 代码管理
上传代码到Gitee
# 方法1:克隆后推送
git clone https://gitee.com/username/repository.git
# 添加文件后
git add .
git commit -m "初始提交"
git push origin main
# 方法2:本地仓库关联
git remote add origin https://gitee.com/username/repository.git
git push -u origin main
使用SSH方式
# 使用SSH地址克隆
git clone git@gitee.com:username/repository.git
# 推送代码
git push origin main
5. 团队协作
添加协作者
- 进入仓库页面
- 点击"管理" → “成员管理”
- 点击"添加成员"
- 输入用户名或邮箱
- 设置权限级别
权限级别
- 访客:只能查看代码
- 报告者:可以创建Issue和Pull Request
- 开发者:可以推送代码到非保护分支
- 维护者:可以管理仓库设置
- 管理员:拥有所有权限
Pull Request流程
- 创建分支:基于主分支创建功能分支
- 开发功能:在分支上进行开发
- 推送分支:将分支推送到Gitee
- 创建PR:在Gitee上创建Pull Request
- 代码审查:团队成员进行代码审查
- 合并代码:审查通过后合并到主分支
6. Issue管理
创建Issue
- 进入仓库页面
- 点击"Issues"标签
- 点击"新建Issue"
- 填写标题和描述
- 设置标签和里程碑
Issue模板
可以创建Issue模板来标准化问题报告:
## 问题描述
[详细描述遇到的问题]
## 复现步骤
1.
2.
3.
## 期望结果
[描述期望的正确行为]
## 实际结果
[描述实际发生的情况]
## 环境信息
- 操作系统:
- 版本:
- 其他相关信息:
7. 项目管理
里程碑管理
- 创建里程碑
- 设置截止日期
- 关联Issue和Pull Request
- 跟踪项目进度
标签管理
- bug:程序错误
- enhancement:功能增强
- documentation:文档相关
- help wanted:需要帮助
- question:问题讨论
8. 高级功能
Gitee Pages
- 进入仓库设置
- 启用Gitee Pages
- 选择分支和目录
- 访问生成的网站
Gitee Go(CI/CD)
- 创建
.gitee/workflows
目录 - 编写工作流配置文件
- 配置构建和部署步骤
示例工作流配置
name: 构建和测试
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: 设置Node.js
uses: actions/setup-node@v2
with:
node-version: '14'
- name: 安装依赖
run: npm install
- name: 运行测试
run: npm test
9. 最佳实践
提交信息规范
<type>(<scope>): <subject>
<body>
<footer>
类型说明:
- feat:新功能
- fix:修复bug
- docs:文档更新
- style:代码格式调整
- refactor:代码重构
- test:测试相关
- chore:构建过程或辅助工具的变动
分支命名规范
- main/master:主分支
- develop:开发分支
- feature/xxx:功能分支
- hotfix/xxx:紧急修复分支
- release/xxx:发布分支
代码审查要点
- 代码逻辑是否正确
- 是否有潜在的安全问题
- 代码风格是否一致
- 是否有适当的注释
- 测试是否充分
10. 常见问题
Q: 如何删除仓库?
A: 进入仓库设置 → 高级设置 → 删除仓库
Q: 如何转移仓库所有权?
A: 进入仓库设置 → 高级设置 → 转移仓库
Q: 如何备份仓库?
A: 使用git clone --mirror
创建镜像仓库
Q: 如何查看仓库统计信息?
A: 在仓库页面查看"统计"标签页
Q: 如何设置仓库可见性?
A: 进入仓库设置 → 基本信息 → 修改可见性