Elixion

Issue Templates

Create and use issue templates to standardize and speed up issue creation

Issue Templates

Issue templates help standardize issue creation by providing pre-filled content and required fields. They ensure consistency and save time for common issue types.

Benefits of Templates

  • Consistency - All issues follow the same structure
  • Speed - Pre-filled content reduces creation time
  • Quality - Required fields ensure complete information
  • Onboarding - New team members know what to include

Template Types

Built-in Templates

Elixion includes these default templates:

Bug Report

## Summary
Brief description of the bug.

## Environment
- Browser:
- OS:
- Version:

## Steps to Reproduce
1.
2.
3.

## Expected Behavior


## Actual Behavior


## Screenshots/Logs
[Attach if applicable]

Feature Request

## Feature Description
What do you want to add?

## User Story
As a [user type],
I want [goal],
so that [benefit].

## Acceptance Criteria
- [ ]
- [ ]

## Additional Context
[Any other information]

User Story

## User Story
As a [user type],
I want [goal/capability],
so that [benefit/reason].

## Acceptance Criteria
### Given/When/Then
- Given [context]
- When [action]
- Then [expected result]

### Additional Criteria
- [ ] Criteria 1
- [ ] Criteria 2

## Design
[Link to design files]

## Technical Notes
[Implementation considerations]

Custom Templates

Create templates specific to your team's needs.

Creating Templates

Step 1: Access Template Settings

  1. Go to Project Settings > Issue Templates
  2. Click + New Template

Step 2: Configure Template

Basic Settings:

  • Name - Template identifier (e.g., "API Bug Report")
  • Description - When to use this template
  • Issue Type - Which type this applies to
  • Icon - Visual identifier

Template Content:

Name: API Bug Report
Description: Use for reporting API-related bugs
Issue Type: Bug

Step 3: Define Fields

Pre-filled Description:

## API Endpoint
`[METHOD] /api/v1/endpoint`

## Request
```json
{
  "example": "request"
}

Expected Response

{
  "expected": "response"
}

Actual Response

{
  "actual": "response"
}

Status Code

Expected: 200 | Actual:

Headers

[Relevant headers]

Steps to Reproduce

  1. Make request to endpoint
  2. Include payload above
  3. Observe error

**Default Values:**
| Field | Default |
|-------|---------|
| Priority | High |
| Labels | api, bug |
| Component | Backend |

**Required Fields:**
- ☑ Title
- ☑ Description
- ☑ Priority
- ☐ Story Points

### Step 4: Set Visibility

- **Project** - Only this project
- **Space** - All projects in space
- **Global** - All projects (admin only)

## Using Templates

### From Issue Creation

1. Click **+ New Issue**
2. Click **Use Template**
3. Select template from list
4. Fill in placeholders
5. Submit

### Quick Selection

Templates appear as options in the issue type dropdown:

Issue Type: ├── Story ├── Task ├── Bug │ ├── Use: Bug Report Template │ ├── Use: API Bug Report │ └── Use: UI Bug Report └── ...


### Keyboard Shortcut

1. Press `Ctrl/Cmd + I` for quick create
2. Type `template:` followed by template name
3. Press Enter to apply

## Template Examples

### Frontend Bug Template

```markdown
## Component
Which component is affected?

## Bug Description
What is happening incorrectly?

## Browser Testing
| Browser | Version | Works? |
|---------|---------|--------|
| Chrome  |         | ☐/☑    |
| Firefox |         | ☐/☑    |
| Safari  |         | ☐/☑    |
| Edge    |         | ☐/☑    |

## Steps to Reproduce
1.
2.
3.

## Expected Behavior


## Actual Behavior


## Console Errors
```javascript
// Paste errors here

Screenshots

Responsive Testing

  • [ ] Desktop (1920px)
  • [ ] Tablet (768px)
  • [ ] Mobile (375px)

### Sprint Retrospective Item

```markdown
## Category
[ ] What went well
[ ] What could be improved
[ ] Action items

## Description
Describe the item.

## Impact
How does this affect the team?

## Proposed Action
What should we do about it?

## Owner
Who will drive this?

## Due Date
When should this be addressed?

Technical Spike Template

## Research Question
What specific question are we trying to answer?

## Time Box
**Maximum Duration:** [X] hours/days

## Background & Context
Why do we need to investigate this?

## Success Criteria
What do we need to learn to consider this complete?

## Research Plan
1.
2.
3.

## Resources
- [ ] Documentation links
- [ ] Similar implementations
- [ ] Subject matter experts

## Expected Deliverables
- [ ] Decision document
- [ ] Proof of concept (if applicable)
- [ ] Effort estimates
- [ ] Risk assessment

## Constraints
Any limitations on the research?

Epic Template

## Epic Overview
High-level description of this initiative.

## Business Objectives
- Objective 1
- Objective 2

## Success Metrics
| Metric | Current | Target |
|--------|---------|--------|
| Metric 1 | X | Y |
| Metric 2 | X | Y |

## Scope

### In Scope
- Feature A
- Feature B

### Out of Scope
- Feature C (future consideration)
- Feature D (not needed)

## Dependencies
- Dependency 1
- Dependency 2

## Timeline
| Milestone | Target Date |
|-----------|-------------|
| Design Complete | |
| Development Start | |
| MVP Release | |
| Full Release | |

## Risks
| Risk | Likelihood | Impact | Mitigation |
|------|------------|--------|------------|
| Risk 1 | High/Med/Low | High/Med/Low | Plan |

## Stakeholders
- @product-owner
- @tech-lead
- @designer

Managing Templates

Editing Templates

  1. Go to Project Settings > Issue Templates
  2. Click template to edit
  3. Make changes
  4. Save

Duplicating Templates

  1. Open template
  2. Click Duplicate
  3. Modify as needed
  4. Save with new name

Archiving Templates

Templates can be archived instead of deleted:

  • Archived templates don't appear in selection
  • Existing issues using them are unaffected
  • Can be restored later

Version History

Templates maintain version history:

  1. View template
  2. Click History
  3. See changes over time
  4. Restore previous version if needed

Best Practices

Template Design

✓ Do:

  • Keep templates focused
  • Use clear placeholders
  • Include examples
  • Make requirements obvious

✗ Don't:

  • Create too many templates
  • Make templates too long
  • Use jargon without explanation
  • Forget to update templates

Placeholder Convention

Use consistent placeholder format:

[Enter title here]
[Describe the bug]
[X] points

Regular Review

  • Review templates quarterly
  • Remove unused templates
  • Update based on feedback
  • Add new ones as needs emerge

Next: Dependencies - Link related issues together