issue-templates

What this skill does

# GitHub Issue Templates

Comprehensive templates for creating different types of GitHub issues. Use these templates to ensure consistency and completeness when creating issues.

---

## Bug Report Template

Use this template when reporting bugs, errors, or unexpected behavior.

```markdown
## Description

Brief, clear description of the bug in 1-2 sentences.

## Steps to Reproduce

1. Go to [specific page or action]
2. Click on [button/link]
3. Enter [specific data]
4. Observe the error

## Expected Behavior

What should happen when following the steps above.

## Actual Behavior

What actually happens. Include error messages, stack traces, or screenshots.

## Environment

- **Browser/OS**: Chrome 120 / macOS 14.2
- **Version/Branch**: v2.1.0 / main
- **Environment**: Production / Staging / Local

## Reproduction Rate

- [ ] Always (100%)
- [ ] Frequently (>50%)
- [ ] Sometimes (<50%)
- [ ] Rare (<10%)

## Screenshots/Logs

[Attach screenshots, error logs, or console output if applicable]

## Additional Context

- When did this start happening?
- Does it affect all users or specific users?
- Any recent changes that might be related?
- Workarounds discovered?

## Impact Assessment

- **Users Affected**: All / Subset / Single user
- **Severity**: Critical / High / Medium / Low
- **Business Impact**: [Describe impact on business operations]

## Suggested Priority

- [ ] P1 - Critical (blocks core functionality, affects all users)
- [ ] P2 - High (significant impact but has workaround)
- [ ] P3 - Normal (minor impact, can be scheduled)
```

### Example Bug Report

```markdown
## Description

Users cannot log in with SSO authentication, receiving "Invalid OAuth state" error.

## Steps to Reproduce

1. Navigate to https://app.example.com/login
2. Click "Login with SSO"
3. Enter corporate email
4. Redirected to error page with "Invalid OAuth state"

## Expected Behavior

User should be authenticated and redirected to dashboard.

## Actual Behavior

Error page displays "Invalid OAuth state parameter" and user cannot proceed.

## Environment

- **Browser/OS**: All browsers / All OS
- **Version/Branch**: v2.3.1 / production
- **Environment**: Production

## Reproduction Rate

- [x] Always (100%)

## Screenshots/Logs

```
Error: OAuth state mismatch
  at validateState (auth.js:45)
  at processCallback (oauth.js:123)
```

## Additional Context

- Started after deployment at 2:00 PM UTC today
- Affects ALL users attempting SSO login
- Username/password login still works
- Related to PR #123 which updated OAuth library

## Impact Assessment

- **Users Affected**: All SSO users (~80% of user base)
- **Severity**: Critical
- **Business Impact**: Users cannot access application, blocking all work

## Suggested Priority

- [x] P1 - Critical (blocks core functionality, affects all users)
```

---

## Feature Request Template

Use this template when proposing new features or enhancements.

```markdown
## Feature Description

Clear, concise description of the proposed feature in 1-2 sentences.

## Problem Statement

What problem does this feature solve? Who experiences this problem?

## Proposed Solution

Detailed description of how the feature should work:

- User interaction flow
- UI/UX considerations
- Technical approach (high-level)

## Acceptance Criteria

- [ ] User can [specific action]
- [ ] System responds with [expected behavior]
- [ ] Edge case [X] is handled properly
- [ ] Feature works on [platforms/browsers]

## User Stories

**As a** [type of user]
**I want** [goal/desire]
**So that** [benefit/value]

## Alternatives Considered

What other approaches were considered and why were they rejected?

## Dependencies

- Requires [feature/component]
- Blocks [other feature]
- Depends on [external service/library]

## Success Metrics

How will we measure if this feature is successful?

- [ ] [Metric 1]
- [ ] [Metric 2]

## Priority Suggestion

- [ ] P1 - Critical (essential for launch/key business need)
- [ ] P2 - High (important enhancement with clear value)
- [ ] P3 - Normal (nice-to-have improvement)

## Additional Context

- Mockups or wireframes
- User research or feedback
- Competitive analysis
- Technical considerations
```

### Example Feature Request

```markdown
## Feature Description

Add dark mode theme option to the application dashboard and user interface.

## Problem Statement

Users working in low-light environments or during evening hours find the bright interface uncomfortable and experience eye strain. Multiple users have requested a dark mode option in feedback surveys.

## Proposed Solution

Implement a theme toggle in user settings:

1. Add theme selector in user preferences (Settings > Appearance)
2. Offer "Light", "Dark", and "Auto (system)" options
3. Persist user preference to database
4. Apply theme across all dashboard components
5. Use CSS variables for easy theme switching

## Acceptance Criteria

- [ ] User can toggle between light and dark mode in settings
- [ ] User can select "Auto" to follow system theme
- [ ] Theme preference is saved per user account
- [ ] Theme persists across sessions and devices
- [ ] All dashboard components support both themes
- [ ] Text remains readable in both themes (WCAG AA contrast)
- [ ] Theme applies immediately without page refresh

## User Stories

**As a** dashboard user
**I want** to switch to dark mode
**So that** I can work comfortably in low-light environments without eye strain

## Alternatives Considered

1. **Single dark mode only**: Rejected - some users prefer light mode
2. **Browser extension**: Rejected - requires external dependency
3. **Time-based auto-switch**: Rejected - too complex for MVP

## Dependencies

- CSS variable system (already implemented)
- User preferences API (needs enhancement)
- Component library updates (all components must support theming)

## Success Metrics

- [ ] 30%+ of users enable dark mode within first month
- [ ] Reduced complaints about interface brightness
- [ ] Positive feedback in user surveys

## Priority Suggestion

- [ ] P1 - Critical
- [x] P2 - High (frequently requested feature with clear user value)
- [ ] P3 - Normal

## Additional Context

- Figma mockups: [link]
- User survey results: 67% requested dark mode
- Similar feature in competitor products
```

---

## Task Template

Use this template for development tasks, technical work, or non-user-facing improvements.

```markdown
## Objective

What needs to be accomplished? Be specific and actionable.

## Context

Why is this task needed? What's the background or motivation?

## Requirements

Detailed list of what must be completed:

- [ ] Requirement 1
- [ ] Requirement 2
- [ ] Requirement 3

## Technical Approach

High-level technical plan or considerations:

1. [Step or component 1]
2. [Step or component 2]
3. [Step or component 3]

## Files/Components Affected

- `path/to/file1.js`
- `path/to/file2.py`
- `component/Module`

## Testing Requirements

- [ ] Unit tests for [component]
- [ ] Integration tests for [workflow]
- [ ] Manual testing of [scenario]
- [ ] Performance testing if applicable

## Documentation Requirements

- [ ] Update README
- [ ] Update API docs
- [ ] Add inline code comments
- [ ] Update changelog

## Dependencies

- Requires completion of #[issue-number]
- Blocked by [external factor]
- Depends on [library/service]

## Definition of Done

- [ ] Implementation complete and tested
- [ ] Code reviewed and approved
- [ ] Tests added and passing
- [ ] Documentation updated
- [ ] No regressions introduced
- [ ] Deployed to staging/production

## Priority

- [ ] P1 - Critical (blocking other work)
- [ ] P2 - High (important technical improvement)
- [ ] P3 - Normal (standard development work)

## Estimated Effort

[Small / Medium / Large] or [hours/days estimate]
```

### Example Task

```markdown
## Objective

Refactor authentication middleware to support multiple OAuth providers (GitHub, Google, Microsoft).

## Context

Currently auth middleware only supports GitHub OAuth.