jira-task

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

When to Use

使用场景

Use this skill when creating Jira tasks for:

Bug reports
Feature requests
Refactoring tasks
Documentation tasks

在为以下场景创建Jira任务时使用本技能：

Bug报告
功能请求
重构任务
文档任务

Multi-Component Work: Split into Multiple Tasks

多组件工作：拆分为多个任务

IMPORTANT: When work requires changes in multiple components (API, UI, SDK), create separate tasks for each component instead of one big task.

重要提示：当工作需要在多个组件（API、UI、SDK）中进行修改时，请为每个组件创建独立的任务，而非一个大型任务。

Why Split?

为什么要拆分？

Different developers can work in parallel
Easier to review and test
Better tracking of progress
API needs to be done before UI (dependency)

不同开发人员可以并行工作
更易于评审和测试
进度跟踪更清晰
API需在UI之前完成（存在依赖关系）

Bug vs Feature: Different Structures

Bug与功能：不同的结构

For BUGS: Create separate sibling tasks

针对BUG：创建独立的同级任务

Bugs are typically urgent fixes, so create independent tasks per component:

Task 1 - API:

Title:

[BUG] Add aws_region field to AWS provider secrets (API)

Must be done first (UI depends on it)

Task 2 - UI:

Title:

[BUG] Add region selector to AWS provider connection form (UI)

Blocked by API task

Bug通常是紧急修复，因此为每个组件创建独立任务：

任务1 - API：

标题：

[BUG] Add aws_region field to AWS provider secrets (API)

必须优先完成（UI依赖此任务）

任务2 - UI：

标题：

[BUG] Add region selector to AWS provider connection form (UI)

被API任务阻塞

For FEATURES: Create parent + child tasks

针对功能：创建父任务+子任务

Features need business context for stakeholders, so use a parent-child structure:

Parent Task (for PM/Stakeholders):

Title:
```
[FEATURE] AWS GovCloud support
```
Contains: Feature overview, user story, acceptance criteria from USER perspective
NO technical details
Links to child tasks

Child Task 1 - API:

Title:
```
[FEATURE] AWS GovCloud support (API)
```
Contains: Technical details, affected files, API-specific acceptance criteria
Links to parent

Child Task 2 - UI:

Title:
```
[FEATURE] AWS GovCloud support (UI)
```
Contains: Technical details, component paths, UI-specific acceptance criteria
Links to parent, blocked by API task

功能需要向利益相关者传递业务上下文，因此使用父-子任务结构：

父任务（面向产品经理/利益相关者）：

标题：
```
[FEATURE] AWS GovCloud support
```
包含：功能概述、用户故事、从用户视角出发的验收标准
不含技术细节
链接至子任务

子任务1 - API：

标题：
```
[FEATURE] AWS GovCloud support (API)
```
包含：技术细节、受影响文件、API专属验收标准
链接至父任务

子任务2 - UI：

标题：
```
[FEATURE] AWS GovCloud support (UI)
```
包含：技术细节、组件路径、UI专属验收标准
链接至父任务，被API任务阻塞

Parent Task Template (Features Only)

父任务模板（仅适用于功能）

markdown

undefined

markdown

undefined

Description

{User-facing description of the feature - what problem does it solve?}

User Story

As a {user type}, I want to {action} so that {benefit}.

Acceptance Criteria (User Perspective)

Out of Scope

{What this feature does NOT include}

{What this feature does NOT include}

Design

Figma: {link if available}
Screenshots/mockups if available

Figma: {link if available}
Screenshots/mockups if available

Child Tasks

```
[FEATURE] {Feature name} (API)
```
- Backend implementation
```
[FEATURE] {Feature name} (UI)
```
- Frontend implementation

```
[FEATURE] {Feature name} (API)
```
- Backend implementation
```
[FEATURE] {Feature name} (UI)
```
- Frontend implementation

Priority

{High/Medium/Low} ({business justification})

undefined

{High/Medium/Low} ({business justification})

undefined

Child Task Template (Features Only)

子任务模板（仅适用于功能）

markdown

undefined

markdown

undefined

Description

Technical implementation of {feature name} for {component}.

Parent Task

[FEATURE] {Feature name}

[FEATURE] {Feature name}

Acceptance Criteria (Technical)

{Technical requirement 1}
{Technical requirement 2}

{Technical requirement 1}
{Technical requirement 2}

Technical Notes

Affected files:
- ```
{file path 1}
```
- ```
{file path 2}
```
{Implementation hints}

Affected files:
- ```
{file path 1}
```
- ```
{file path 2}
```
{Implementation hints}

Testing

{Test case 1}
{Test case 2}

{Test case 1}
{Test case 2}

Related Tasks

Parent:
```
[FEATURE] {Feature name}
```
Blocked by: {if any}
Blocks: {if any}

undefined

Parent:
```
[FEATURE] {Feature name}
```
Blocked by: {if any}
Blocks: {if any}

undefined

Linking Tasks

任务关联

In each task description, add:

markdown

undefined

在每个任务描述中添加：

markdown

undefined

Related Tasks

Parent: [Parent task title/link] (for child tasks)
Blocked by: [API task title/link]
Blocks: [UI task title/link]

undefined

Parent: [Parent task title/link] (for child tasks)
Blocked by: [API task title/link]
Blocks: [UI task title/link]

undefined

Task Template

通用任务模板

markdown

undefined

markdown

undefined

Description

{Brief explanation of the problem or feature request}

Current State:

{What's happening now / What's broken}
{Impact on users}

Expected State:

{What should happen}
{Desired behavior}

{Brief explanation of the problem or feature request}

Current State:

{What's happening now / What's broken}
{Impact on users}

Expected State:

{What should happen}
{Desired behavior}

Acceptance Criteria

{Specific, testable requirement}
{Another requirement}
{Include both API and UI tasks if applicable}

{Specific, testable requirement}
{Another requirement}
{Include both API and UI tasks if applicable}

Technical Notes

{Implementation hints}
{Affected files with full paths}
{Dependencies or related components}

{Implementation hints}
{Affected files with full paths}
{Dependencies or related components}

Testing

Priority

{High/Medium/Low} ({justification})

undefined

{High/Medium/Low} ({justification})

undefined

Title Conventions

标题规范

Format:

[TYPE] Brief description (components)

Types:

```
[BUG]
```
- Something broken that worked before
```
[FEATURE]
```
- New functionality
```
[ENHANCEMENT]
```
- Improvement to existing feature
```
[REFACTOR]
```
- Code restructure without behavior change
```
[DOCS]
```
- Documentation only
```
[CHORE]
```
- Maintenance, dependencies, CI/CD

Components (when multiple affected):

```
(API)
```
- Backend only
```
(UI)
```
- Frontend only
```
(SDK)
```
- Prowler SDK only
```
(API + UI)
```
- Both backend and frontend
```
(SDK + API)
```
- SDK and backend
```
(Full Stack)
```
- All components

Examples:

[BUG] AWS GovCloud accounts cannot connect - STS region hardcoded (API + UI)

```
[FEATURE] Add dark mode toggle (UI)
```

[REFACTOR] Migrate E2E tests to Page Object Model (UI)

[ENHANCEMENT] Improve scan performance for large accounts (SDK)

格式：

[TYPE] Brief description (components)

类型：

```
[BUG]
```
- 原本正常的功能出现故障
```
[FEATURE]
```
- 新增功能
```
[ENHANCEMENT]
```
- 对现有功能的改进
```
[REFACTOR]
```
- 代码重构，不改变功能行为
```
[DOCS]
```
- 仅涉及文档
```
[CHORE]
```
- 维护工作、依赖更新、CI/CD相关

组件（多组件受影响时）：

```
(API)
```
- 仅后端
```
(UI)
```
- 仅前端
```
(SDK)
```
- 仅Prowler SDK
```
(API + UI)
```
- 后端与前端
```
(SDK + API)
```
- SDK与后端
```
(Full Stack)
```
- 所有组件

示例：

[BUG] AWS GovCloud accounts cannot connect - STS region hardcoded (API + UI)

```
[FEATURE] Add dark mode toggle (UI)
```

[REFACTOR] Migrate E2E tests to Page Object Model (UI)

[ENHANCEMENT] Improve scan performance for large accounts (SDK)

Priority Guidelines

优先级指南

Priority	Criteria
Critical	Production down, data loss, security vulnerability
High	Blocks users, no workaround, affects paid features
Medium	Has workaround, affects subset of users
Low	Nice to have, cosmetic, internal tooling

优先级	判定标准
Critical（紧急）	生产环境宕机、数据丢失、安全漏洞
High（高）	阻碍用户操作，无替代方案，影响付费功能
Medium（中）	有替代方案，仅影响部分用户
Low（低）	锦上添花的功能、界面美化、内部工具优化

Affected Files Section

受影响文件部分

Always include full paths when known:

markdown

undefined

已知文件路径时，请始终提供完整路径：

markdown

undefined

Technical Notes

Affected files:

```
api/src/backend/api/v1/serializers.py
```

ui/components/providers/workflow/forms/aws-credentials-form.tsx

```
prowler/providers/aws/config.py
```

undefined

Affected files:

```
api/src/backend/api/v1/serializers.py
```

ui/components/providers/workflow/forms/aws-credentials-form.tsx

```
prowler/providers/aws/config.py
```

undefined

Component-Specific Sections

组件专属内容

API Tasks

API任务

Include:

Serializer changes
View/ViewSet changes
Migration requirements
API spec regeneration needs

需包含：

序列化器变更
View/ViewSet变更
迁移需求
API规范重新生成需求

UI Tasks

UI任务

Include:

Component paths
Form validation changes
State management impact
Responsive design considerations

需包含：

组件路径
表单验证变更
状态管理影响
响应式设计考量

SDK Tasks

SDK任务

Include:

Provider affected
Service affected
Check changes
Config changes

需包含：

受影响的提供商
受影响的服务
检查逻辑变更
配置变更

Checklist Before Submitting

提交前检查清单

✅ Title follows
```
[TYPE] description (components)
```
format
✅ Description has Current/Expected State
✅ Acceptance Criteria are specific and testable
✅ Technical Notes include file paths
✅ Testing section covers happy path + edge cases
✅ Priority has justification
✅ Multi-component work is split into separate tasks
✅ Titles are recommended for all tasks

✅ 标题符合
```
[TYPE] description (components)
```
格式
✅ 描述包含当前状态/预期状态
✅ 验收标准具体且可测试
✅ 技术说明包含文件路径
✅ 测试部分覆盖正常流程+边缘情况
✅ 优先级带有理由
✅ 多组件工作已拆分为独立任务
✅ 所有任务均推荐设置标题

Output Format

输出格式

For BUGS (sibling tasks):

针对BUG（同级任务）：

markdown

undefined

markdown

undefined

Recommended Tasks

Task 1: [BUG] {Description} (API)

{Full task content}

Task 2: [BUG] {Description} (UI)

{Full task content}

undefined

{Full task content}

undefined

For FEATURES (parent + children):

针对功能（父任务+子任务）：

markdown

undefined

markdown

undefined

Recommended Tasks

Parent Task: [FEATURE] {Feature name}

{User-facing content, no technical details}

Child Task 1: [FEATURE] {Feature name} (API)

{Technical content for API team}

Child Task 2: [FEATURE] {Feature name} (UI)

{Technical content for UI team}

undefined

{Technical content for UI team}

undefined

Formatting Rules

格式规则

CRITICAL: All output MUST be in Markdown format, ready to paste into Jira.

Use
```
##
```
for main sections (Description, Acceptance Criteria, etc.)
Use
```
**bold**
```
for emphasis
Use
```
- [ ]
```
for checkboxes
Use ``` for code blocks with language hints
Use
```
backticks
```
for file paths, commands, and code references
Use tables where appropriate
Use
```
---
```
to separate multiple tasks

**重要提示：**所有输出必须为Markdown格式，可直接粘贴至Jira。

使用
```
##
```
标记主要章节（描述、验收标准等）
使用
```
**加粗**
```
进行强调
使用
```
- [ ]
```
创建复选框
使用```添加带语言提示的代码块
使用
```
反引号
```
标记文件路径、命令和代码引用
适当使用表格
使用
```
---
```
分隔多个任务

Jira MCP Integration

Jira MCP集成

CRITICAL: When creating tasks via MCP, use these exact parameters:

**重要提示：**通过MCP创建任务时，请使用以下精确参数：

Required Fields

必填字段

json

{
  "project_key": "PROWLER",
  "summary": "[TYPE] Task title (component)",
  "issue_type": "Task",
  "additional_fields": {
    "parent": "PROWLER-XXX",
    "customfield_10359": {"value": "UI"}
  }
}

json

{
  "project_key": "PROWLER",
  "summary": "[TYPE] Task title (component)",
  "issue_type": "Task",
  "additional_fields": {
    "parent": "PROWLER-XXX",
    "customfield_10359": {"value": "UI"}
  }
}

Team Field (REQUIRED)

团队字段（必填）

The

customfield_10359

(Team) field is REQUIRED. Options:

```
"UI"
```
- Frontend tasks
```
"API"
```
- Backend tasks
```
"SDK"
```
- Prowler SDK tasks

customfield_10359

（团队）字段为必填项。可选值：

```
"UI"
```
- 前端任务
```
"API"
```
- 后端任务
```
"SDK"
```
- Prowler SDK任务

Work Item Description Field

工作项描述字段

IMPORTANT: The project uses

customfield_10363

(Work Item Description) instead of the standard

description

field for display in the UI.

CRITICAL: Use Jira Wiki markup, NOT Markdown:

```
h2.
```
instead of
```
##
```
```
*text*
```
for bold instead of
```
**text**
```
```
* item
```
for bullets (same)
```
** subitem
```
for nested bullets

After creating the issue, update the description with:

json

{
  "customfield_10363": "h2. Description\n\n{content}\n\n*Current State:*\n* {problem 1}\n* {problem 2}\n\n*Expected State:*\n* {solution 1}\n* {solution 2}\n\nh2. Acceptance Criteria\n\n* {criteria 1}\n* {criteria 2}\n\nh2. Technical Notes\n\nPR: [{pr_url}]\n\nAffected files:\n* {file 1}\n* {file 2}\n\nh2. Testing\n\n* [ ] PR - Local environment\n** {test case 1}\n** {test case 2}\n* [ ] After merge in prowler - dev\n** {test case 3}"
}

**重要提示：**项目使用

customfield_10363

（工作项描述）替代标准

description

字段用于UI展示。

重要提示：请使用Jira Wiki标记语言，而非Markdown：

使用
```
h2.
```
替代
```
##
```
使用
```
*text*
```
实现加粗，而非
```
**text**
```
使用
```
* item
```
创建项目符号（与Markdown相同）
使用
```
** subitem
```
创建嵌套项目符号

创建问题后，使用以下内容更新描述：

json

{
  "customfield_10363": "h2. Description\n\n{content}\n\n*Current State:*\n* {problem 1}\n* {problem 2}\n\n*Expected State:*\n* {solution 1}\n* {solution 2}\n\nh2. Acceptance Criteria\n\n* {criteria 1}\n* {criteria 2}\n\nh2. Technical Notes\n\nPR: [{pr_url}]\n\nAffected files:\n* {file 1}\n* {file 2}\n\nh2. Testing\n\n* [ ] PR - Local environment\n** {test case 1}\n** {test case 2}\n* [ ] After merge in prowler - dev\n** {test case 3}"
}

Common Epics

常见史诗

Epic	Key	Use For
UI - Bugs & Improvements	PROWLER-193	UI bugs, enhancements
API - Bugs / Improvements	PROWLER-XXX	API bugs, enhancements
LightHouse AI	PROWLER-594	AI features
Technical Debt - UI	PROWLER-502	Refactoring

史诗	编号	使用场景
UI - Bugs & Improvements	PROWLER-193	UI缺陷、功能增强
API - Bugs / Improvements	PROWLER-XXX	API缺陷、功能增强
LightHouse AI	PROWLER-594	AI功能
Technical Debt - UI	PROWLER-502	代码重构

Workflow Transitions

工作流状态转换

Backlog (10037) → To Do (14) → In Progress (11) → Done (21)
                → Blocked (10)

Backlog (10037) → To Do (14) → In Progress (11) → Done (21)
                → Blocked (10)

MCP Commands Sequence

MCP命令序列

Create issue:

mcp__mcp-atlassian__jira_create_issue

Update Work Item Description:

mcp__mcp-atlassian__jira_update_issue with customfield_10363

Assign and transition:

mcp__mcp-atlassian__jira_update_issue (assignee)
mcp__mcp-atlassian__jira_transition_issue (status)

创建问题：

mcp__mcp-atlassian__jira_create_issue

更新工作项描述：

mcp__mcp-atlassian__jira_update_issue with customfield_10363

分配与状态转换：

mcp__mcp-atlassian__jira_update_issue (assignee)
mcp__mcp-atlassian__jira_transition_issue (status)

Keywords

关键词

jira, task, ticket, issue, bug, feature, prowler