bug-report-template Templates

A collection of templates used when creating bug report issues.

Bug Report Templates#

A collection of templates used when creating bug report issues.

Template A: Full Bug Report#

Full template including image analysis and detailed information:

## Bug Description

{Brief summary of the bug}

## Screenshots/Videos

{Image URL or description}

### Image Analysis Results
- **Screen**: {screen name}
- **UI State**: {error dialog / empty screen / loading state, etc.}
- **Error Message**: {extracted error message}

## Reproduction Steps

1. {precondition}
2. {step_1 - first step}
3. {step_2 - second step}
4. {step_3 - bug occurrence step}

## Expected Result

{Expected result during normal operation}

## Actual Result

{Current problem occurring}

## Environment Information

| Item | Value |
|------|-------|
| OS | {os_version} |
| Device | {device_model} |
| App Version | {app_version} |
| Network | {network_type} |

## Additional Information

{Logs, stack traces, additional context}

---
 >   Generated by `/bug-report`

Template B: Simple Bug Report#

Simple template with minimum information:

## Bug Description

{Bug summary}

## Reproduction Steps

1. {step_1}
2. {step_2}
3. {step_3}

## Expected vs Actual

- **Expected**: {expected}
- **Actual**: {actual}

## Environment

- OS: {os}
- App Version: {version}

---
 >   Generated by `/bug-report`

Template C: Crash Report#

Template specifically for crashes/ANR:

## Crash Summary

{Crash situation summary}

## Crash Type

- [ ] App force close (Crash)
- [ ] Not responding (ANR)
- [ ] Screen frozen (Freeze)

## Reproduction Steps

1. {precondition}
2. {step_1}
3. {step_2}
4. **Crash occurs**

## Reproduction Rate

- [ ] Always reproducible (100%)
- [ ] Frequently reproducible ( > 50%)
- [ ] Sometimes reproducible ( < 50%)
- [ ] Occurred once only

## Environment Information

| Item | Value |
|------|-------|
| OS | {os_version} |
| Device | {device_model} |
| App Version | {app_version} |
| Memory Status | {memory_status} |

## Stack Trace

\`\`\`
{stack_trace}
\`\`\`

## Related Logs

\`\`\`
{relevant_logs}
\`\`\`

---
 >   Generated by `/bug-report` - Crash Report

Template D: UI Bug Report#

Template for UI/layout related bugs:

## UI Bug Summary

{UI issue summary}

## Bug Type

- [ ] Layout broken
- [ ] Overflow
- [ ] Style error
- [ ] Animation issue
- [ ] Responsive issue

## Screenshots

{Image URL}

### Affected Components
- Screen: {screen_name}
- Widget: {widget_name}
- Area: {affected_area}

## Reproduction Conditions

- Screen size: {screen_size}
- Device: {device}
- Orientation: {orientation}

## Expected UI vs Actual UI

| Item | Expected | Actual |
|------|----------|--------|
| Alignment | {expected_align} | {actual_align} |
| Size | {expected_size} | {actual_size} |
| Color | {expected_color} | {actual_color} |

## Related Design

- Figma: {figma_link}

---
 >   Generated by `/bug-report` - UI Bug

Issue Title Templates#

General Bug#

[Bug] {screen_name}: {bug_summary}

Examples:

[Bug] Login: Social login button not working
[Bug] Home: Banner image loading failure

Crash#

[Crash] {screen_name}: {crash_situation}

Examples:

[Crash] Profile: Crash on image selection
[Crash] Payment: ANR on completion screen

UI Bug#

[UI] {screen_name}: {UI_issue}

Examples:

[UI] List: Long text overflow
[UI] Detail: Bottom button overlap

Label Combination Examples#

Critical Crash#

labels:
  - bug
  - severity:critical
  - crash
  - priority:urgent
  - needs-investigation

High Functional Bug#

labels:
  - bug
  - severity:high
  - area:backend
  - priority:high

Medium UI Bug#

labels:
  - bug
  - severity:medium
  - area:ui

Low Typo/Alignment#

labels:
  - bug
  - severity:low
  - area:ui
  - good-first-issue

Workflow Integration Output#

Issue Creation Complete Message#

╔════════════════════════════════════════════════════════════════╗
║  Bug Report Created                                            ║
╠════════════════════════════════════════════════════════════════╣
║                                                                ║
║  📋 Issue: #{issue_number}                                     ║
║  📝 Title: {issue_title}                                       ║
║                                                                ║
║  🏷️ Labels:                                                    ║
║    - bug                                                       ║
║    - {severity_label}                                          ║
║    - {area_label}                                              ║
║                                                                ║
║  📊 Pipeline: {pipeline}                                       ║
║  📈 Estimate: {estimate} points                                ║
║                                                                ║
║  🔗 URL: {issue_url}                                           ║
║                                                                ║
║  💡 Next Steps:                                                ║
║    - /dev:bugfix {issue_number}  # Start fix cycle             ║
║    - Manually create branch and work                           ║
║                                                                ║
╚════════════════════════════════════════════════════════════════╝

Image Analysis Result Message#

╔════════════════════════════════════════════════════════════════╗
║  Image Analysis Result                                         ║
╠════════════════════════════════════════════════════════════════╣
║                                                                ║
║  🖼️ Image: {image_path}                                        ║
║                                                                ║
║  📍 Detected Issues:                                           ║
║    1. {issue_1}                                                ║
║    2. {issue_2}                                                ║
║                                                                ║
║  🏷️ Suggested Classification:                                  ║
║    - Type: {bug_type}                                          ║
║    - Severity: {severity}                                      ║
║    - Area: {area}                                              ║
║                                                                ║
║  📝 Extracted Text:                                            ║
║     " {extracted_error_message} "                                   ║
║                                                                ║
║  🔍 Screen Context:                                            ║
║    - Screen: {detected_screen}                                 ║
║    - State: {ui_state}                                         ║
║                                                                ║
╚════════════════════════════════════════════════════════════════╝