Jira 字段提示(字段配置描述 + Message Custom Field)
一 、场景
- 开发在处理完缺陷,选择解决结果的时候,应该选择哪一个值?设计如此 和 无需修改有什么不一样?不想经常对齐概念,希望对每一个解决结果给注释说明,应该怎么做?
- 开发在遇到提测申请单时候,应该注意哪些规范,对于一些总是出错的地方怎么给与提示,要把团队内的规范文档直接放到这些JIRA页面的上,方便随时查阅,要怎么做?
本文记录两种做法,都不需要写代码:
- 字段配置里的描述
- Message Custom Field类型的自定义字段。
二、 字段描述写在哪
2.1 两个位置
自定义字段自身的描述:【管理】-【问题】-【自定义字段】- 找到字段 -【编辑详细信息】
字段配置层的描述:【管理】-【问题】-【字段】-【字段配置】- 选目标配置 -【配置】- 找到字段 -【编辑详细信息】
2.2 谁覆盖谁
字段配置层优先。两处都写了描述的话,页面上显示的是字段配置里的那份。
说明:字段配置和字段配置方案不是一回事。方案决定哪个项目用哪个配置,配置里才是具体字段的设置。改之前先确认项目挂的是哪个方案。
释疑:为什么 Jira 要把描述分成两层
字段配置是挂在项目和问题类型上的。
同一个字段,在 A 项目里可能要写"必填,写清版本号",在 B 项目里含义完全不同。只留一层的话,改一处会影响所有项目。
分成两层之后,自定义字段里那份是默认值,字段配置里那份按项目覆盖。
注意:系统字段没有前面那一层。像解决结果这种 Jira 自带的字段,只能在字段配置里写描述。
三、 字段配置的描述
3.1 操作路径
【管理】-【问题】-【字段】-【字段配置】- 选目标配置 -【配置】- 找到字段 -【编辑详细信息】- 填【描述】
3.2 显示在哪
- 创建、编辑 issue 页面里,在字段的下方
- 问题导航器里作为帮助文本
注意:字段配置是按方案生效的,一个方案可能挂着多个项目。动手之前先确认目标项目用的是哪套,别改到别的项目上去。
四、Message Custom Field(for edit)类型字段
4.1 为什么要用它
字段配置的描述是挂在字段上的:字段出现在哪个屏幕,提示就跟到哪儿。
要让提示不依附任何字段——比如固定在页面顶部,或者单独占一个页签——字段配置就做不到了。
Message Custom Field 是专门干这个的:它不收集数据,只显示一段固定文字,建好后关联到屏幕就是一块独立的提示区。
注意:网上讲这个的做法,一般会先让你去【管理】-【系统】-【一般配置】-【编辑设置】里打开 Enable HTML in custom field descriptions and list item values。我这台实例(Jira DC 10.3.2)上它是关的,字段配置的描述和 Message 字段的 HTML 都照样渲染,这一步不用做。官方对这个开关本身倒是建议保持关闭。
4.2 创建字段
- 【管理】-【问题】-【自定义字段】-【添加自定义字段】
- 类型选Message Custom Field (for edit)
- 填字段名称,选择适用的项目和问题类型
- 关联到对应的 Screen
选择字段类型
关联 Screen
4.3 写内容
回到自定义字段列表,找到刚建的字段,点齿轮 -【配置】-【编辑默认值】,把 HTML 写进去。
编辑默认值
页面上渲染出来的效果
4.4 一个限制
官方文档写明,这个做法不适用于编辑和流转屏幕,因为 Comment 字段会被自动加进去。所以它能用的地方主要是创建屏幕和详情页。
五、 两个方法怎么选
- 提示跟着某个字段走(比如"解决结果该选哪个值"),用方法一。写进字段配置的描述即可,不用新建字段,以后改起来也快。
- 提示不依附任何字段,要单独占一块地方,用方法二。
- 能不能上色、放链接,不是分界线,两边都能写 HTML。分界线是提示挂在哪。