56 KiB

Raw Blame History

红山开源平台开源项目使用手册

1. 开源项目：项目管理

项目是用户创建的对应于一个小组或团队的协同实践社区，由项目管理员、开发人员和报告人员组成，提供问题跟踪、版本管理、里程碑、代码质量分析、资源托管、交流研讨等功能。

注意：未开展分组作业或项目开发的用户暂不涉及本章内容。

1.1 基本操作流程

开源项目是一种协同实践社区，支持团队和小组开展各种协作活动。开源项目的典型操作流程如下：

项目创建：团队（或小组）的核心成员首先创建一个项目。
成员添加：通知团队其他成员在红山开源平台上注册（如已注册则忽略此步），将团队成员加入项目。
问题跟踪：发布不同类型的问题，指派给责任人，并跟踪问题的解决进度。
版本管理：基于Git版本库实现分布式版本控制。
交流互动：基于讨论区等工具开展深度技术交流和研讨。上述步骤的详细操作参见以下章节。

1.2 项目创建

项目创建包括：1、导入外站项目；2、创建项目。

1、导入外站项目点击右上角“⊕”，选择“导入项目”，如下图所示：

填写项目基本信息，包括项目拥有者、镜像版本库地址、项目名称、项目简介等信息，并点击“创建项目”如下图所示：

2、创建托管项目点击右上角“⊕”，选择“新建项目”，如下图所示：

填写项目基本信息，包括项目拥有者、项目名称、项目简介等信息，并点击“创建项目”如下图所示：

1.3 代码库

代码库为开源项目的核心功能页面，通常作为项目的首页（默认页面）。

用户可以在此页面进行项目代码及项目基本信息的浏览、查看项目不同分支、标签内容。以及创建PR、提交Issue、上传文件、获取项目下载地址等操作。

1.4 疑修（Issue）

1.4.1 Issue简介

Issue主要用于团队成员或相关人员对项目中出现的问题、任务或需求等进行记录和跟踪。

Issue 具有不同的状态，如 “新建”“进行中”“已解决”“已关闭” 等。通过这些状态，团队成员和管理者可以直观地了解问题或任务的当前进展情况，便于及时发现问题、调整计划。

1.4.2 Issue创建

点击“疑修(Issue)”，进入标签页，点击页面右侧的创建疑修。
进入创建疑修页面后，用户需要根据项目实际情况，填写Issue标题及内容，选择指派成员、状态、类型、优先度等。填写完毕后点击创建按钮即可完成Issue的创建。
出现如下图所示信息时，表明问题发布成功。

1.4.3 Issue互动

注意：每个问题都相当于一个可以进度追踪的帖子。因此支持回复、点赞、@等。在问题截止日期的前一天，系统将对问题的发布人和被指派人发送提示消息。

点击已发布的问题，进入问题详情页面，点击下图所示的评论区输入栏。

点开输入栏后出现下图所示输入界面，输入想要评论的内容后，点击“评论”。

出现如下图所示信息时，表明评论成功。

1.5 合并请求（PR）

1.5.1 功能简介

Pull Request 译为拉取请求，是两个仓库提交变更的一种方式，通常用于 fork 仓库与被 fork 仓库的差异提交，同时也是为团队项目或开源项目做贡献的一种非常好的团队协作方式。你拉取并修改了他人的代码后，将你的修改告知给代码的原作者，请求他合并你的修改，就称为 Pull Request。

图解PR

1.6 里程碑

1.6.1 功能简介

里程碑功能主要是用于将大型开源项目拆解为多个具有明确目标和交付成果的阶段，以此为参照跟踪项目进度，清晰呈现项目是超前、按时还是滞后。它能在各阶段合理分配任务，明确团队成员职责，促进高效协作，还能聚焦并解决项目推进时出现的问题，有助于凝聚社区力量，实现版本有序发布，提升项目透明度，传承知识经验，推动开源项目顺利开展。

1.6.2 新建里程碑

管理员可以新建里程碑。步骤如下：

1、点击“里程碑”，进入标签页，点击页面右侧的“新建里程碑”。

2、填写新里程碑相关信息，包括标题、描述等，选择截止日期后，点击“创建里程碑”。

3、出现如下图所示信息时，表明新的里程碑创建成功。

注意：项目成员在发布问题时。将在“目标版本”属性中看到新建的版本。

1.6.3 关联里程碑

项目成员可以将项目问题关联到里程碑，从而使里程碑包含明确的任务列表。步骤如下： 1、进入某个问题的页面，编辑“里程碑”属性，从“里程碑”下拉框中选择适当的里程碑，点击“提交”。 2、出现如下图所示信息时，表明里程碑关联成功。

1.7 维基（Wiki）

Wiki 是一种协作式的知识管理系统，通常用于存储和共享项目相关的设计、文档和注释,允许多个用户共同创建、编辑、更新和分享内容,用户无需特殊技能即可编辑页面，通常使用所见即所得，各个页面之间通过超链接相互连接，形成网络状的知识结构。进入项目详情选择维基（Wiki）菜单，可选择创建新的文档或导入已有的模板。

点击“创建Wiki文档”，输入文档标题、和内容，可选择周报或月报模板，帮助快速记录工作记录：

新建成功后进入wiki文档列表页面，左侧为已存在的文档目录，右侧显示所选中的文件的详细内容;在搜索框钟输入文件名可查询所需文档；同时可复制页面下方的HTTPS或者SSH地址可用git命令clone当前所有wiki文档：

1.新建目录:在一级菜单增加一个文件夹，点击文件夹名称右侧按钮，可在当前目录内增加子目录、子页面；或者可对此目录进行删除或者重命名操作：

2.新增页面:进入新增Wiki页面，保存一个新的文档信息 3.导入模板:可选择导入的模板类型，导入后自动生成一个wiki文档

4.导出:可选择导出类型markdown、html、pdf等

5.复制及编辑:复制并新增一个文档或者对当前文档进行内容、标题的修改

6.预览:查看导出页面内容 7.删除文档:点击目录名右侧按钮，悬浮下拉框内选择删除按钮,二次确认后删除文档

1.8 Reposyncer仓库同步（New🆕）

1.8.1 功能简介

红山开源平台支持不同开源托管平台自动同步推送/拉取相关代码，实现多平台项目同步开发功能。

跨平台仓库代码同步服务用于不同代码托管平台之间的仓库代码双向同步。用户将不同平台的仓库分支进行绑定，当任意仓库分支有push事件被webhook监听时，代码推送将实时自动同步至另一个仓库，以实现不同平台之间分支、提交信息的自动同步。

1.8.2 仓库同步配置

如果项目列表未出现服务按钮，请先移步至仓库设置=>项目导航=> 勾选开启服务后重新刷新进入该仓库

进入需要同步代码的项目内，选择服务，输入平台信息：点击开始体验，选择开源托管平台后根据提示输入相关信息（以Github为例）：

点击下一步，进入配置同步仓库webhook阶段，复制链接后前往开源平台进行仓库配置: 在相关平台增加webhook后，继续点击下一步,选择首次同步方向且选择同步分支：选择同步代码，所选择的仓库分支会被覆盖，当前项目不存在所选分支时会新建分支并将代码合并：

同步后会生成一条记录，可查看第三方平台仓库和分支、红山开源分支、最后最新的同步时间和同步状态，同时可启动或中止当前的同步配置，不用重复配置相同信息：点击同步记录，可查看当前同步配置失败或成功的日志：同步列表内点击“添加同步分支”按钮，可增加新的仓库同步分支，后续步骤同上：

在同步列表内点击“同步配置”可查看已配置信息或者更新同步仓库授权token：当不需要实时同步第三方平台的代码时，点击“解绑此仓库”勾选仓库并删除已配置的仓库信息：

1.9 项目配置

项目的管理员可以对项目进行多种配置。可配置的内容主要包括：

项目基本设置：包括项目名称、简介、可见性、标识、类别、语言等基本项目信息，以及转移仓库及删除仓库等操作。
成员管理：为项目添加各种角色的成员，点击“成员”标签页。
网络钩子（WebHook）：支持设置自定义的WebHook来实现自动化推送等操作。
分支设置：为项目设置默认分支及分支保护。
Bot管理：用于管理（新增、删除）当前项目所配置的Bot。

1.9.1 成员管理

项目管理员可以在项目配置中管理项目的成员。

1、点击“仓库设置”，进入标签页，选择左侧菜单栏的“协作者管理”，将看到如下页面： 2、在下图所示的搜索框内输入欲添加成员的用户名，如下图所示： 3、在搜索结果中选择想要添加的成员，点击“添加成员”，如下图所示： 4、成员添加成功后，可为其选择角色，包括管理员、开发者、报告者三种，如下图所示：注意：项目成员的不同角色具有不同权限。管理员：可以对项目中的所有模块进行操作。开发者：不能对项目进行配置。报告者：不能对版本库进行操作。

1.9.2 删除项目

管理员可以删除项目。步骤如下：点击“仓库设置”，进入标签页，选择左侧菜单栏的“基本设置”，点击下方的“删除本仓库”，即可删除当前项目。

2. 开源项目：组织管理

为了满足团队开发、协作、宣传和管理需要，红山开源提供了组织功能。

2.1 组织创建

在用户登录状态下，点击右上角用户头像，选择开源主页。
进入开源主页后，点击组织按钮
点击新建组织，跳转至新建组织页面并输入组织相关信息，输入完成后点击创建组织进行创建

2.2 组织页面配置及介绍

在2.1 组织创建点击创建组织后，网站将自动跳转至组织页面。

点击组织页面右上角设置按钮进入组织页面配置页面

组织设置共分为四个模块：基本设置、组织首页管理、组织成员管理、组织团队管理

基本设置

在组织配置的基本设置中，可对当前组织的组织名称、组织描述、官方网站、所在地区、可见性、权限、最大仓库数、组织头像（推荐上传正方形图片）进行修改。

其中，组织名称、组织描述、可见性、组织头像为必填项，其余为选填项；用户可根据自身需求进行相关的编辑及修改。
组织首页管理

在组织首页管理当中，主要可对两个部分进行相应配置：新闻动态、组织介绍（均不是必填项，若不填写组织页面将进行隐藏显示）。

其中新闻动态图片推荐大小为288*120
- 新闻动态
  - 新闻动态图片大小288*120
  - 新闻动态原文链接，此处可以填写相应的网站链接。用户点击新闻即可进行跳转
  - 新闻动态标题，此处为新闻的标题信息
  - 新闻动态内容，此处为新闻的动态内容，最多可输入200字
- 组织介绍
  - 此处为组织介绍，需填写组织的相关信息。支持markdown语法
组织成员管理

组织成员管理页面可查看、添加、删除组织的成员。
- 点击右上角添加成员进行人员添加（需要选择添加人员的组织团队）
  
  选择组织团队之后跳转至人员添加页面，点击右上角搜索框，输入需要添加的用户名对平台用户进行搜索
  
  点击对应用户，点击右侧按钮添加成员进行人员添加。
组织团队管理

3. 开源项目：版本管理

版本管理又称版本控制，是一种分布式协同编程的重要工具。没有掌握好版本管理工具，团队式协同开发是不可想象的。

红山开源平台集成了Gitlab版本管理系统，可以提供标准的Git版本库操作流程。因此，在使用本平台提供的Git仓库时。可以直接参考本手册。也可以在互联网中搜索相关问题的解决方法。详见：Git使用指南（https://git-scm.com/book/zh/v2）

注意：未开展项目开发的用户暂不涉及本章内容。

3.1 基本操作流程

Git版本库的使用非常灵活，功能非常强大，但其基本流程也是非常简单的：

在平台上新建远程版本库或fork一个远程版本库
将远程库clone到本地
在本地库中创建分支（缺省为master）
提交（commit）代码到本地分支
推送（push）代码到远程库的分支/下拉（pull）远程库的代码到本地
解决冲突
合并分支

以上是一个在实际操作中反复进行的基本流程。

注意：在多人协同编程的情况下，每个成员在开发自己的模块时，尽可能先从master或developer分支下载最新代码，并与本地分支合并，否则时间久了，合并分支将是一个灾难。上连基本流程可以使用Git命令行客户端、Tortoise Git客户端等工具完成。

3.2 fork版本库

用户对某一个版本库的fork操作将会为该用户创建一个同名项目和同名版本库。

操作步骤：进入需要fork的版本库页面，点击右上角的Fork按钮即可。

注意：任何用户都可以fork一个公开的版本库。连续两次fork同一版本时，系统将直接跳转到第一次fork后的版本库。

3.3 新建版本库

管理员可以新建版本库。步骤如下:

进入相应的开源项目的“项目配置”页面
点击“版本库”标签页，点击“新建版本库”链接
填写版本库名称后，点击“创建”

注意：同一用户名下的版本不能重名。平台也将在近期提供SSH访问方式。

3.4 克隆版本库(clone)

克隆版本库是将开源项目的版本库完整的克隆到本地的过程。其中包括了版本库的所有提交记录。步骤如下：

确定需要克隆的版本库地址：从项目的版本库页面中即可找到该地址
在本地的git命令行执行：
```
git clone https://git.osredm.com/xxx/yyy.git
```
其中“https:// git.osredm.com /xxx/yyy.git”是版本库的地址，xxx为用户ID，yyy为项目名称
如果项目是私有的，根据提示输入版本库用户名和密码，输入当前用户的红山开源平台登录名和密码即可

注意：如果项目公开, 无需输入口令, 可以直接克隆。对于私有项目，只有项目成员才具有克隆的权限。

3.5 新建分支、切换分支

新建分支

新建分支是指在本地库创建一个新的分支（用于开发新的功能），并且将其同步到远程库。主要步骤如下:
1. 从已有的分支创建新的分支（如从master分支），例如创建一个dev分支： git checkout -b dev
2. 创建后可以查看一下当前分支，确认当前分支已经切换到dev： git branch dev master
3. 提交该新的分支到远程仓库: git push origin dev:devl
  
  其中: dev为本地新建分支:devl为远程分支，如果devl不存在则会自动创建分支。这里，dev应该等于devl。
切换分支

切换分支是指将当前工作分支换为另一个分支。假设，本地仓库有master和dev两个分支，当前分支是master（其实也可以是其他分支）。那么切换到dev分支的命令是： git checkout dev

注意：用户可以使用git branch命令确认当的分支是否已经切换到dev

3.6 提交代码(commit)

项目成员在本地编辑代码或修改文件后，可以将新修改的文件提交到本地库:

将新修改的所有文件添加到本地版本库的暂存区（stage）： git add .

注意：如果仅添加单个文件，或一类文件，可以： git add somefile.txt #添加单个文件
将提交到暂存区的修改提交到本地的当前分支： git commit -m “myfirstcommit”

其中，“mycommit”中的内容是关于本次提交的说明文字。

注意：commit只能将修改的文件提交到本地库，与远程库没有关系。

3.7 推送代码(push)

项目成员可以将本地提交后的改动，推送到远程库。

假设用户需要将本地库的dev分支推送至远程库的dev分支，执行： git push -u origin dev

如果用户的当前的本地分支己经是dev, 那么执行: git push

如果用户需要将本地的全部分支推送到远程库。那么执行： git push -all origin

注意： push代码时会提示输入用户密码，请输入红山开源平台登录名和密码即可。 Push代码之前通常要先pull，解决冲突后才能提交，否则不是最新的文件就提交不上去。

3.8 下拉代码(pull)

下拉代码是指从远程版本库获取代码文件到本地分支。

例如，用户希望将远程版本库的devl分支下拉到本地的dev分支，需要执行： git pull origin dev devl

注意：下拉代码时可能会出现冲突（即两个分支对同一个文件的同一行代码做了不同的修改）。此时常利用merge来解决冲突。

3.9 合并分支(merge)

合并分支是指将一个分支合并到当前分支。通常有两种情况：

将一个本地分支合并到当前分支：

例如，假设用户希望将本地库的devl分支合并到当前分支dev ,命令如下: git merge dev1

将一个远程库的分支合并到当前分支：

例如，假设用户希望将远程库的devl分支合并到当前分支dev,有多种方法，这里仅给出最基本的：

git checkout -b temp #新建一个临时分支temp
git pull origin dev1:temp #将远程devl分支下拉到temp分支
git checkout dev #切换到本地dev分支
git merge temp #合并分支(可能 产生冲突，合并完成后，应删除temp分支)

注意:合并分支可能会出现冲突（即两个分支对同一个文件的同一行代码做了不同的修改）。

3.10 解决冲突

冲突是两次不同的提交修改了同一行代码导致的，通常表现为两个分支对同一行代码做了不同的修改。版本冲突主要出现在以下两种情况：

第一种情况：在对远程版本库进行pull操作时。

第二种情况：对本地版本库的不同分支进行merge操作时。

解决冲突的主要方法有两种：

对于简单的冲突，直接修改有冲突的文件，然后重新提交即可
对于复杂的冲突，需要用git merge tool来解决。复杂的冲突解决方法(基于git merge tool)将在近期提供给大家

3.11 常见错误

新手在使用Git时经常遇到各种错误，由于平台集成的是标准Git服务(Gitlab)，建议大家可以直接在互联网搜索疑难问题的解决办法。或参考Git使用手册： https://git-scm.com/book/zh/v2 为给大家提供方便，这里先列出一种最常见的错误：

错误1:

fatal:The remote end hung up unexpectedly

Windows环境解决方法，在.git/config文件中加入： [http] postBuffer = 524288000

Linux环境解决方法，在命令行执行： git config http.postBuffer 524288000

注：后续我们将列出更多的错误解决办法。

4. 工程化管理子系统-工作台（New🆕）

工程化管理子系统-工作台，红山开源平台是面向开源项目组织量身打造的功能模块。全面支持产品、项目、流水线、代码库、知识库以及用户的管理与协同工作，通过权限设置、沟通协作工具等，确保不同角色的用户能够在一个安全、有序的环境中高效协作。助力组织高效开展项目工程化管理，实现项目全流程的有序推进与多方协作。

4.1 开通工作台

鼠标移入顶部导航栏头像，选择开源主页，点击组织显示组织列表。

进入组织详情，点击“开通工作台”按钮：首次创建组织工作台时，系统将根据组织团队用户在组织工作台中根据不同团队初始化成不同角色，一个组织至少有一个成员才能开通工作台。 1.组织管理员：原owner团队成员，对组织内所有代码库均具有管理员权限，在组织工作台中拥有最高管理权限 2.项目管理员：原管理员团队成员，对组织内所有代码库均具有管理员权限，在组织工作台中拥有项目管理权限 3.普通成员：原开发者及报告者团队成员，对组织内所有代码库均具有开发者权限，在组织工作台中拥有项目基础使用权限及查看权限

4.2 工作台

工作台模块显示了当前用户负责的工作项（包括任务、需求、缺陷）以及用户创建的产品需求（为0则不显示），同时可直观的查看当前用户负责和创建的工作项、相关项目以及正在运行中的迭代数据

4.3 产品

4.3.1 需求

点击左侧菜单栏的产品按钮，右侧会显示当前组织下的所有产品的基本信息，包括名称、描述、负责人、更新时间，用户可以通过关键字搜索查找特定的产品，也可以按照更新时间对产品进行排序。

此外，平台提供了“新建产品”按钮，用户可以通过点击快速从零开始创建新的产品。

在列表中，用户可以删除、编辑产品并对产品进行置顶或者取消置顶操作；注意：删除产品会删除产品下所有数据：

点击产品列表中的产品名称，进入产品详情页面，产品包括需求和计划两部分；需求页面左侧是产品模块，可根据模块筛选右侧的需求列表，同时也可以根据负责人、发布人、状态以及标记等筛选需求数据，也可以根据优先级、更新时间、创建时间、开始和结束时间、优先级等对需求进行数据排序；筛选项过多后可点击“重置”按钮清除筛选项。

在列表中点击对应需求的优先级列，在下拉项中选择需要修改的优先级，优先级分为低、正常、高、紧急四个，用户可以根据当前层级安排完成顺序。产品模块可点击右上角的按钮进行新建：

在需求页面点击右上角的“新建需求”按钮，会弹出新建抽屉，输入需求信息，标题、正文、优先级（默认为正常）为必填项；点击“提交”按钮，抽屉关闭，列表内会更新新增加的数据；点击“创建下一个”，列表数据更新的前提下抽屉不会关闭，清除上一次输入的内容，可继续增加下一个需求：

4.3.2 计划

在页面顶部点击选择“计划”，计划列表内显示标题、产品需求数、开始时间、结束时间、状态、优先级等数据；用户可根据计划名称搜索，也可根据优先级和状态进行数据筛选；同时，列表内可根据开始、结束时间以及优先级对计划进行排序显示。

点击右上角“新建计划”按钮，输入计划标题、描述、选择优先级、开始和结束时间：

点击计划标题进入计划详情页，详情页将显示计划所关联的需求列表；针对列表中显示的状态、优先级等数据，可在当前页对计划进行删除、完成、编辑、关联需求等操作：

点击“选择需求”，右侧弹出选择弹框，搜索需求后可点击右侧操作列，将对应需求移入计划内；

点击“编辑计划”，弹出编辑弹窗，输入需要修改的内容，确定后列表数据会刷新显示：

点击“删除计划”或者完成计划，按照弹窗指引进行数据操作，删除计划后相关信息不会再显示但不会删除计划下的相关需求，已完成的计划列表内对应数据状态会更新为已完成，且完成计划按钮会变为“重开计划”：

4.4 项目

项目版块汇聚和管理了当前组织下的所有项目。进入“项目”版块（左侧菜单选择项目）。列表内展示了与组织相关的所有项目，用户可以通过关键字搜索查找或者根据状态、负责人等筛选特定的项目，也可以按照更新时间对项目进行排序。

点击操作列内的“编辑项目”按钮会弹出弹窗，可根据需求对项目进行修改保存：

因删除项目时，项目内的所有数据均会被删除，所以会弹出二次确认弹框，以免误操作：

点击项目列表页面的“新建项目”按钮，弹出新建弹框，输入项目的相关信息，可将团队成员加入项目中：

在项目列表中，点击项目名称进入项目详情，详情分为上下两部分，顶部包括项目状态、名称、以及项目的子项：

4.4.1 概览

项目概览包括项目的基本信息、工作项（包含需求、缺陷、任务三个部分）数据统计、公告栏、工作项趋势分析等四个部分。可根据实时数据修改公告提示，以便组织内所有成员了解项目的完成情况。

4.4.2 需求

在顶部菜单栏中选择需求菜单项，列表中显示了当前项目中包含的所有需求的基本信息：需求名称、优先级（分为低、正常、高、紧急）、负责人、状态（分为待评审、进行中、已完成、已关闭、已拒绝）、标记、创建人、创建时间；其中可根据需求名称筛选列表数据，也可点击全部、开启中、已关闭三个选择切换当前列表；同时，数据也可根据时间和优先级进行排序操作。用户可直接在列表中更新状态、标记以及负责人三个数据，如下图，点击对应需求的状态值出现下拉框，选择后即可修改：

新建需求：点击右上角的按钮会弹出右侧抽屉；新建时选择负责人：负责人可在工作台找到当前需求，同时可根据标记查找到对应数据；选择关联迭代：将新建的需求加入迭代中；预估工时：完成当前需求所需时间；开始和结束时间：当前需求需要在一定时间范围内容完成。

4.4.3 任务

在顶部菜单栏中选择任务菜单项，列表中显示了当前项目中包含的所有任务的基本信息：任务标题、优先级（分为低、正常、高、紧急）、负责人、状态（分为待处理、进行中、已完成、已关闭、已拒绝）、标记、创建人、创建时间；其中可根据任务标题筛选列表数据，也可点击全部、开启中、已关闭三个选择切换当前列表；同时，数据也可根据时间和优先级进行排序操作。

用户可直接在列表中更新状态、标记以及负责人三个数据，如下图，点击对应任务的负责人出现下拉框，下拉框内可根据关键字搜索项目内的成员，选择后即可修改任务负责人：

新建任务：点击右上角的按钮会弹出右侧抽屉；新建时选择负责人：负责人可在工作台找到当前任务，同时可根据标记查找到对应数据；选择关联迭代：将新建的任务加入迭代中；预估工时：完成当前任务所需时间；开始和结束时间：当前任务需要在一定时间范围内容完成。

4.4.4 缺陷

在顶部菜单栏中选择缺陷菜单项，列表中显示了当前项目中包含的所有缺陷的基本信息：标题、优先级（分为低、正常、高、紧急）、负责人、状态（分为待修复、修复中、已修复、已关闭、已拒绝）、标记、创建人、创建时间；其中可根据缺陷标题筛选列表数据，也可点击全部、开启中、已关闭三个选择切换当前列表；同时，数据也可根据时间和优先级进行排序操作。

用户可直接在列表中更新状态、标记以及负责人三个数据，如下图，点击对应缺陷的标记出现下拉框，下拉框内可根据关键字搜索当前组织内已存在的标记，选择后即可修改任务标记：

新建缺陷：点击右上角的按钮会弹出右侧抽屉；新建时选择负责人：负责人可在工作台找到当前缺陷，同时可根据标记查找到对应数据；选择关联迭代：将新建的缺陷加入迭代中；预估工时：完成当前缺陷所需时间；开始和结束时间：当前缺陷需要在一定时间范围内容完成。

4.4.5 代码

在顶部菜单栏中选择代码菜单项，列表中显示了当前项目中包含的所有代码库的基本信息：标题、代码库语言、更新时间、点赞数、fork数；平台提供输入代码库关键字进行搜索，也可根据更新时间、创建时间、fork数量以及点赞数对列表进行倒序排序。

4.4.6 迭代

在顶部菜单栏中选择迭代菜单项，列表中显示了当前项目中包含的所有迭代的基本信息：标题、状态（分为未开始、进行中、已关闭）、负责人、起止时间、工作项进度（已完成工作项/全部工作项）、工时容量；其中可根据迭代标题筛选列表数据，也可勾选全部、开启中、已关闭三个状态切换当前列表。

点击列表右侧操作列编辑按钮，可对迭代信息进行编辑保存：

点击列表右侧操作列的删除按钮，可删除不需要的迭代，不会删除迭代下的工作项数据：

点击迭代列表右上角的“新建迭代”按钮，迭代名称、负责人以及起止时间为必填，确定新建迭代后列表数据更新：

点击迭代列表右上角的“规划迭代”按钮进入规划页面，从左边列表选择工作项（需求、任务、缺陷）拖拽至右侧的任一迭代中，拖拽后可在右侧查看当前迭代所包含的工作项数量；左侧工作项数据过多的情况下可根据工作项标题、类型、状态、负责人、优先级筛选左侧数据：

迭代详情：在迭代列表中点击相应迭代标题进入迭代详情页面，当前迭代还未开始时点击页面右上角的“开始迭代”按钮，选择起止时间点击确定迭代状态会更新成进行中：

当前迭代为进行中时，可以点击“完成迭代”按钮，将迭代改为已关闭状态；当迭代中有工作项还未完成时，可选择将未完成工作项设置为已关闭、移出当前迭代并设置为未规划或者将其转移至其他迭代，如下图所示：

详情分为左右两部分：左侧为所有迭代列表，右侧显示对应迭代的基础信息、工作项完成度的燃尽图以及当前迭代所关联的测试单列表：右侧点击菜单“工作项”，可切换显示当前迭代所包含的工作项列表，鼠标移入“全部”可选择需求、任务、缺陷进行列表筛选左侧迭代列表：可点击顶部筛选按钮弹出筛选框，可输入迭代标题关键字或者选择负责人、迭代状态等搜索对应的迭代信息

点击左侧“未规划工作项”，右侧会对应刷新显示没有加入迭代的所有工作项：在迭代详情页点击右上角的“新建工作项”按钮，选择工作项类型，保存的工作项会默认添加到当前迭代：

4.4.7 测试

点击顶部菜单的测试项，测试包含测试用例、测试单、测试报告三个部分。

4.4.7.1 测试用例

测试用例分为左右两部分：左侧为用例模块的树状图，右侧为用例列表，左侧点击用例模块右侧数据会筛选出选中模块下的所有用例，未选择模块的情况下默认显示所有测试用例。左侧部分：会显示所有模块数量以及可一键展开或收起所有模块；在右上角点击加号可添加模块（如下图一所示）；鼠标移入模块时会显示菜单按钮，可选择编辑、删除当前模块或者在当前模块下新建一个子模块（如下图二所示）。

右侧部分：列表显示测试用例的标题、维护人、标记、类型、创建时间等数据，可输入用例名称进行搜索，同时可选择维护人、标记以及类型筛选数据，并且通过创建时间排序等。同时，可勾选标题左侧的多选框，对多个测试用例进行修改维护人、标记、类型、用例模块等。新建用例：点击右上角按钮，右侧弹出弹窗；标题、维护人、类型为必填项；打开新建弹框，会默认增加一条空的测试步骤，可点击“添加步骤”新增一个步骤或者点击右侧的复制按钮来增加一条一样的步骤数据，同时可通过鼠标移入编号列拖拽来调整步骤的先后顺序。用例详情：在用例列表中点击用例标题，右侧弹出弹框，弹框内显示用例的所有信息，同时，点击标题右侧的编辑按钮，用户可对用例内容进行修改保存；弹层右上角有“复制链接”和“删除用例”的图标，可对用例链接进行复制或者删除当前用例。

4.4.7.2 测试单

点击选择菜单栏中的“测试单”按钮，进入测试单列表页面，页面提供测试单的标题、负责人、状态、通过率（通过用例个数/（通过+失败+阻塞+未执行）用例个数）、已测数、关联迭代等数据显示；用户可筛选未开始、进行中、已完成的状态数据，同时可输入测试单名称搜索相关数据；在操作列中提供删除测试单的操作按钮，点击删除图标，二次确认后即可删除当前测试单。同时，列表操作列中点击编辑的图标，可在弹框中修改测试单的基本信息，如标题、计划时间、负责人以及关联迭代等。

在表格中点击标题列内容，进入测试单详情；页面显示测试单的通过率、状态、负责人、关联迭代、计划时间以及测试单下所有的测试用例；左侧只会显示有测试用例的用例模块；点击右上角的“新增用例”按钮，增加的测试用例会自动加入当前测试单。测试单添加测试用例：在测试单详情页面右侧点击“添加用例”；弹框中显示当前项目的测试用例中所有的用例模块和用例，用户通过搜索用例标题、用例类型和维护人找到对应的用例数据并选择，可一次性选择多个；点击确认后即可将用例加入当前测试单。

4.4.7.3 测试报告

点击菜单项测试报告，切换至测试报告列表页，页面提供标题、创建人、关联测试单、创建时间等数据显示；同时可点击列表操作列的删除图标删除测试报告；数据过多的情况下可通过报告名称以及创建人和测试单来筛选报告数据。新建测试报告：输入标题、选择要关联的测试单，会生成对应测试单内所有测试用例的测试情况。

测试报告详情：详情内包含相关测试单下所有的测试用例的信息，包括每个测试用例的测试人员，测试开始时间显示的是所有测试用例的开始时间中最早的数据，而结束时间则是所有测试用例的结束时间中最晚的值。报告总结以及测试负责人可在当前页面进行编辑保存；同时可点击页面右上角的“下载测试报告”按钮下载 PDF 文档。

4.4.8 知识库

点击项目详情顶部菜单栏的“知识库”菜单项，获取对应项目下的所有知识库数据。用户可新建文档、文件夹、上传文件、导入 wiki 等；同时用户可筛选自己创建和收藏的知识库数据。新建文档：需要输入文档的标题和内容，同时设置权限控制（私有、项目成员只读、项目成员读写等）。新建文件夹：输入文件夹名称和项目成员的权限设置（只读、私有、读写等）文件夹点击提交后列表会新增一条文件夹数据，点击文件夹名称可进入子目录进行查看；在列表中可通过操作列对数据进行置顶、删除、设置、收藏等操作。导入Wiki：选择当前组织下的仓库，可以同步所选仓库下的Wiki文档，权限与代码库保持一致

4.4.9 周报

选择周报菜单项，记录当前成员这一周完成的工作；对当前已完成的工作项做总结，并将所有成员提交的周报记录形成周总结。填写本周周报：自动识别本周日期，输入周报内容

4.5 代码库

左侧菜单选择进入“代码库”版块。查看当前组织下所有的代码库列表信息。页面可根据关键字搜索代码库，并根据更新时间、创建时间、fork 数量、点击数量等对列表进行排序。

4.6 知识库

对于普通用户，仅可以操作（置顶，设置，删除）具有读写权限的知识库和自己创建的知识库，另外可以查看、收藏所有具有读权限的知识库。对于组织管理员可以操作（置顶、设置，删除，收藏）所有知识库。

文档：鼠标移入新建按钮，选择文档选项，输入标题、权限、内容等信息保存形成文档数据选择文档数据，进入文档信息详情，可点击右侧按钮编辑文档信息以及返回列表页面
文件夹新建文件夹选项，在知识库根目录增加一个文件夹，并设置组织成员权限，默认全员只读
上传文件上传文件选项，上传一个现有的文件，并设置组织成员权限，默认全员只读
导入wiki：选择wiki文档进入详情，显示目录详情，左侧可增加同级或子级目录、收藏文档、导出文档、删除wiki、搜索目录等操作；右侧则对当前文档内容进行编辑和预览 1>.新增、收藏、导出以及删除 2>.编辑wiki内容：点击右侧编辑按钮 3>.预览页面输入搜索关键词，列表展示符合关键词的知识库；选择我创建的，列表则展示我创建的知识库；选择我收藏的，列表则展示我收藏的知识库。

4.7 成员

组织管理员在这里对用户进行角色分配，可以删除用户的权限，也可以编辑用户的权限，同时也可以添加一个用户进入组织。另外可以在左上角对所有成员进行一个搜索操作，筛选出符合关键词的用户。在列表中选择角色一栏可以修改对应成员的权限操作列点击“移出组织”按钮，将对应成员移出当前组织，移出后该用户不能再进入当前组织点击右上角“添加成员”按钮，根据昵称搜索用户，选择其用户角色再点击“添加”按钮，将用户加入当前组织，默认新成员是普通成员角色，已加入成员则添加按钮置灰不可点击。

4.8 设置

在当前用户有权限的情况下，选择左侧的设置按钮，默认进入组织的基本设置页面，可修改组织名称和组织描述，组织账号是唯一标识则不可修改；无权限需要组织管理员配置权限才能访问设置页面。

4.8.1 基本设置

删除组织工作台：危险操作，会永久删除组织的产品、项目信息且无法恢复，因此需再次输入登录密码，保证当前用户是否有权限进行此操作。

### 4.4.8.2 角色及权限配置组织管理员管理组织角色与权限的模块，有普通成员、组织管理员、项目经理、产品经理、测试人员和客户默认六个角色，暂不允许编辑与删除

点击任意角色名称，配置角色权限：勾选各菜单项相关的权限，输入角色描述，设置角色名称

新增角色： ### 4.4.8.3 标记设置针对不同模块的需求设置不同的标记

点击新建标记，将标记增加至对应的模块下：

5.0 Bot市场（New🆕）

注册或者安装一个已存在的Bot，自动化处理繁杂或重复性的项目任务，例如代码库git推送和分支的创建与删除、合并请求与疑修的打开、关闭、删除、编辑及评论等。点击顶部菜单项进入Bot市场页面：wei 点击“立即注册”进入个人Bot开发页面，输入bot名称、详细介绍、webHook地址、回调地址、选择代码库、疑修和合并请求的权限（必选一项），选择bot状态，私有即只有当前用户可以查看且安装，设置为公开后会显示在Bot市场列表页面，其它用户也可选择安装：新建成功进入bot详情页，当前显示Bot所有者、botID、客户端ID、Bot地址、客户端密钥、私钥、更新头像以及bot的基本信息：选择左侧权限&订阅菜单项，可编辑保存当前Bot权限：选择高级选项可对Bot进行公开、删除、私有、转让等操作： 1．转让所有权：将Bot转让给新的所有者，所选用户接受后转让成功 2．删除Bot 3．公开、私有Bot：更改Bot状态 4．上架市场：输入上架的Bot名称、简介、主要功能、次要功能以及详细介绍等信息以便上架后用户了解和使用，点击“申请上架”按钮：上架成功后，进入Bot详情页面，用户可点击“安装此Bot”按钮：选择需要安装当前Bot的仓库或者安装到当前用户的所有仓库：安装成功后，可点击查看详情进入当前用户的Bot安装列表，查看已安装的所有Bot，可配置Bot信息或者卸载：点击“配置”按钮，可重新修改Bot的应用场景，更改状态：挂起/启用（阻塞/授予Bot对所应用仓库的访问权限）。

56 KiB Raw Blame History Unescape Escape