diff --git a/docs/使用指南/合并请求.md b/docs/使用指南/合并请求.md deleted file mode 100644 index a4ac1c2..0000000 --- a/docs/使用指南/合并请求.md +++ /dev/null @@ -1,72 +0,0 @@ -# 合并请求 - -## 创建合并请求 - -1. 在代码仓库页面,点击"合并请求"标签 -2. 点击"新建合并请求"按钮 -3. 选择源分支和目标分支 -4. 填写合并请求标题和描述 -5. 点击"创建合并请求"按钮 - -## 关联疑修 - -在创建或编辑合并请求时,您可以关联相关的疑修: - -1. 在合并请求描述中,使用 `#` 符号引用疑修编号,例如 `#123` -2. 系统会自动将合并请求与疑修关联 -3. 关联后,您可以在疑修详情页面查看相关的合并请求 -4. 当合并请求被合并时,系统会自动更新疑修状态 - -## 关联平台公告 - -如果您的合并请求涉及平台公告的更新,您可以: - -1. 在合并请求描述中,使用 `@` 符号引用平台公告,例如 `@公告标题` -2. 系统会自动将合并请求与平台公告关联 -3. 关联后,您可以在平台公告详情页面查看相关的合并请求 -4. 当合并请求被合并时,系统会自动更新平台公告状态 - -## 合并请求状态 - -合并请求可能处于以下状态: - -- 打开:等待审查和合并 -- 已合并:代码已合并到目标分支 -- 已关闭:合并请求被拒绝或取消 - -## 审查合并请求 - -1. 查看代码变更 -2. 添加评论 -3. 批准或请求更改 -4. 合并或关闭合并请求 - -## 最佳实践 - -1. 保持合并请求的独立性,每个合并请求应该只解决一个问题 -2. 编写清晰的合并请求描述,说明变更的目的和影响 -3. 及时响应审查意见 -4. 确保代码通过所有自动化测试 -5. 在合并前解决所有冲突 - -## 常见问题 - -### 如何解决合并冲突? - -1. 在本地更新目标分支 -2. 将目标分支合并到您的分支 -3. 解决冲突 -4. 提交更改 -5. 推送更新后的分支 - -### 如何撤销合并请求? - -1. 在合并请求页面点击"关闭"按钮 -2. 选择关闭原因 -3. 确认关闭 - -### 如何重新打开已关闭的合并请求? - -1. 在已关闭的合并请求页面 -2. 点击"重新打开"按钮 -3. 确认重新打开 \ No newline at end of file diff --git a/docs/合并请求/合并请求关联疑修.md b/docs/合并请求/合并请求关联疑修.md index ac29313..c476740 100644 --- a/docs/合并请求/合并请求关联疑修.md +++ b/docs/合并请求/合并请求关联疑修.md @@ -3,4 +3,63 @@ sidebar_label: '合并请求关联疑修' sidebar_position: 5 --- -# 合并请求关联疑修 \ No newline at end of file +# 合并请求关联疑修 + +## 功能介绍 + +合并请求关联疑修功能允许您在创建或编辑合并请求时,将相关的疑修与合并请求建立关联。这样可以帮助团队成员更好地追踪代码变更与疑修之间的关系,提高开发效率。 + +## 如何关联疑修 + +### 方法一:在合并请求描述中引用 + +1. 在创建或编辑合并请求时,在描述中使用 `#` 符号引用疑修编号 +2. 例如:`修复 #123 中提到的登录问题` +3. 系统会自动识别并建立关联 + +### 方法二:在疑修详情页关联 + +1. 打开疑修详情页面 +2. 点击"关联合并请求"按钮 +3. 选择要关联的合并请求 +4. 确认关联 + +## 关联后的效果 + +1. 在疑修详情页面可以看到关联的合并请求列表 +2. 在合并请求详情页面可以看到关联的疑修信息 +3. 当合并请求被合并时,系统会自动更新疑修状态 +4. 可以通过关联关系快速追踪代码变更 + +## 管理关联关系 + +### 查看关联 + +1. 在疑修详情页面的"关联合并请求"部分查看 +2. 在合并请求详情页面的"关联疑修"部分查看 + +### 解除关联 + +1. 在疑修详情页面: + - 找到要解除关联的合并请求 + - 点击"解除关联"按钮 + - 确认操作 + +2. 在合并请求详情页面: + - 找到要解除关联的疑修 + - 点击"解除关联"按钮 + - 确认操作 + +## 最佳实践 + +1. 在创建合并请求时,及时关联相关的疑修 +2. 使用清晰的描述说明合并请求与疑修的关系 +3. 定期检查关联关系,确保其准确性 +4. 在合并请求被合并后,及时确认疑修状态 + +## 注意事项 + +1. 一个合并请求可以关联多个疑修 +2. 一个疑修可以关联多个合并请求 +3. 关联关系建立后可以随时修改 +4. 解除关联不会影响已合并的代码变更 \ No newline at end of file diff --git a/docs/平台公告/平台公告.md b/docs/平台公告/平台公告.md index 3b451a8..a8b53db 100644 --- a/docs/平台公告/平台公告.md +++ b/docs/平台公告/平台公告.md @@ -1,4 +1,85 @@ --- sidebar_label: '平台公告' sidebar_position: 1 ---- \ No newline at end of file +--- + +# 平台公告 + +## 功能介绍 + +平台公告功能允许管理员发布和管理平台相关的通知、更新和重要信息。通过平台公告,可以及时向用户传达重要信息,确保用户了解平台的最新动态。 + +## 创建平台公告 + +1. 进入平台公告管理页面 +2. 点击"新建公告"按钮 +3. 填写公告标题和内容 +4. 设置公告类型和优先级 +5. 选择发布范围 +6. 点击"发布"按钮 + +## 公告类型 + +平台公告支持以下类型: + +- 系统更新:平台功能更新和系统维护通知 +- 功能发布:新功能发布和功能介绍 +- 活动通知:平台活动、比赛和培训通知 +- 重要提醒:安全提醒和重要政策变更 +- 其他通知:其他类型的平台通知 + +## 公告管理 + +### 编辑公告 + +1. 在公告列表中找到要编辑的公告 +2. 点击"编辑"按钮 +3. 修改公告内容 +4. 点击"保存"按钮 + +### 删除公告 + +1. 在公告列表中找到要删除的公告 +2. 点击"删除"按钮 +3. 确认删除操作 + +### 公告状态 + +公告可能处于以下状态: + +- 草稿:未发布的公告 +- 已发布:正在显示的公告 +- 已过期:超过显示期限的公告 +- 已归档:已归档的公告 + +## 公告显示 + +### 显示位置 + +1. 平台首页公告栏 +2. 用户个人中心 +3. 相关功能页面 + +### 显示规则 + +1. 按优先级排序显示 +2. 按发布时间倒序排列 +3. 支持置顶显示 +4. 支持定时发布和自动过期 + +## 最佳实践 + +1. 公告标题要简洁明了 +2. 内容要清晰易懂 +3. 重要信息要突出显示 +4. 及时更新和删除过期公告 +5. 合理设置公告优先级 +6. 注意公告的时效性 + +## 注意事项 + +1. 公告内容要符合平台规范 +2. 避免发布重复或过时的信息 +3. 重要公告要及时通知用户 +4. 定期清理过期公告 +5. 注意公告的权限管理 \ No newline at end of file