diefu 迭复背诵辅助工具 参与开发操作指南

一、项目基础信息

仓库地址：https://gitee.com/justinlee_pb/diefu 项目名称：迭复背诵辅助工具 diefu 用途：基于间隔重复算法的背诵记忆辅助工具

二、两种参与方式

方式1：本地拉取代码开发（推荐开发者）

1. 环境前置要求

1. 安装 Git：https://git-scm.com/downloads
2. 安装项目对应运行环境（根据项目技术栈补充）
3. Gitee 注册账号，联系作者 justinlee_pb 获取仓库开发权限

2. 克隆代码到本地

打开 Git Bash / 终端，执行：

# HTTPS 克隆
git clone https://gitee.com/justinlee_pb/diefu.git
# 进入项目文件夹
cd diefu

3. 新建开发分支（规范：不直接在master/main修改代码）

所有新增功能/修复bug都新建分支，禁止直接提交主分支

# 拉取最新代码
git pull
# 创建并切换新分支，命名规范：feat-功能名 / fix-问题描述
git checkout -b feat-add-word-review

4. 本地开发、修改代码后提交

# 暂存所有修改文件
git add .
# 提交注释规范
# feat: 新增功能 | fix: 修复bug | opt: 优化代码 | doc: 更新文档
git commit -m "feat: 新增自定义背诵计划功能"
# 推送本地分支到远程
git push origin feat-add-word-review

5. 提交合并请求（PR）

1. 打开仓库页面：https://gitee.com/justinlee_pb/diefu
2. 点击「Pull Request」→ 新建PR
3. 源分支：自己新建的分支；目标分支：master
4. 填写修改内容、测试情况，提交等待作者审核合并

方式2：仅提需求/反馈BUG（普通使用者）

1. 进入仓库主页 → 【Issues】
2. 新建Issue，分两类模板：
   • Bug反馈：写明操作步骤、异常现象、系统环境
   • 功能建议：描述需求场景、预期效果

三、仓库初始化（仓库所有者 justinlee_pb 自用）

1. Gitee网页新建仓库步骤

1. 右上角「+」→ 新建仓库
2. 仓库名：diefu，简介：迭复背诵辅助工具
3. 不勾选 README、.gitignore、开源协议
4. 创建仓库，复制仓库地址

2. 本地已有代码上传完整命令

# 进入本地项目根目录
cd /你的本地diefu文件夹
# 全局配置一次git账号（只需执行1次）
git config --global user.name "justinlee_pb"
git config --global user.email "你的gitee绑定邮箱"
# 初始化仓库
git init
# 添加全部文件
git add .
# 初次提交
git commit -m "init: 迭复背诵工具初始代码"
# 绑定远程仓库
git remote add origin https://gitee.com/justinlee_pb/diefu.git
# 推送至主分支
git push -u origin master

四、日常开发通用命令（参与者常备）

# 拉取远程最新代码
git pull origin master
# 查看当前分支
git branch
# 切换已有分支
git checkout master
# 放弃本地全部未提交修改
git checkout .
# 查看修改记录
git log

五、规范说明（提交代码必须遵守）

1. 分支规范
   • 新功能：feat-xxx
   • 缺陷修复：fix-xxx
   • 代码优化：opt-xxx
   • 文档更新：doc-xxx
2. 提交注释规范：类型: 内容描述，简洁清晰
3. 禁止直接推送代码到 master 主分支，必须走PR审核
4. 提交前自测功能，避免提交未完成、报错代码

六、常见问题解决

1. 推送代码提示权限不足 进入Gitee个人设置 → 私人令牌，创建令牌，推送时密码输入令牌字符串
2. 本地与远程代码冲突

   git pull origin master --allow-unrelated-histories
   # 手动解决冲突后重新提交推送
   git add .
   git commit -m "merge: 解决代码冲突"
   git push

3. 提示 remote origin 已存在

   git remote remove origin
   # 重新绑定仓库地址
   git remote add origin https://gitee.com/justinlee_pb/diefu.git

七、联系作者

仓库负责人：justinlee_pb 如有开发权限申请、项目疑问，可在仓库Issue留言沟通。