Skip to main content

Bug Report Template

Template​

# Bug Report: [Short Bug Title]

## Issue Summary
### Description
[A clear and concise description of the bug]

### Environment
- **OS:** [e.g., macOS 12.1]
- **Browser:** [e.g., Chrome 97.0.4692.71]
- **App Version:** [e.g., 1.2.3]
- **Device:** [e.g., MacBook Pro M1]

### Severity
- [ ] Critical (System crash, data loss)
- [ ] High (Major feature broken)
- [ ] Medium (Feature partially broken)
- [ ] Low (Minor issue)

### Priority
- [ ] Immediate (24h)
- [ ] High (3 days)
- [ ] Medium (1 week)
- [ ] Low (2 weeks)

## Steps to Reproduce
1. [First Step]
2. [Second Step]
3. [Third Step]
4. [...]

## Expected Behavior
[What should happen]

## Actual Behavior
[What actually happens]

## Error Information
### Error Message

[Paste the exact error message here]


### Stack Trace

[Paste the stack trace here if available]


### Console Output

[Paste any relevant console output]


## Additional Context
### Screenshots
[Add screenshots if applicable]

### Video Recording
[Add video link if applicable]

### Related Issues
- [Link to related issue #1]
- [Link to related issue #2]

## Debug Information
### Code Version
```bash
git rev-parse HEAD
[Commit hash]

Dependencies​

{
  "dependency1": "version",
  "dependency2": "version"
}

Configuration​

{
  "setting1": "value1",
  "setting2": "value2"
}

Impact​

Affected Users​

  • All Users
  • Specific User Group: [Specify]
  • Single User

Business Impact​

[Description of business impact]

Workaround​

[Temporary solution if available]

Investigation Notes​

Attempted Solutions​

  1. [Solution 1]
  2. [Solution 2]

Relevant Logs​

[Paste relevant log entries]

Debugging Steps​

  1. [Step 1]
  2. [Step 2]
  3. [Step 3]

Usage Guide​

When to Use​

  • Reporting software bugs
  • Tracking system issues
  • Documenting defects
  • Creating QA reports

Best Practices​

  1. Issue Summary

    • Be clear and concise
    • Include version info
    • Set correct severity
    • Set appropriate priority

  2. Reproduction Steps

    • Be specific
    • Include all steps
    • Note preconditions
    • List requirements

  3. Error Information

    • Include full messages
    • Add stack traces
    • Show console output
    • Attach logs

  4. Context

    • Add screenshots
    • Include videos
    • Link related issues
    • Show configurations

Example​

# Bug Report: Login Form Submission Fails on Safari

## Issue Summary
### Description
Users are unable to submit the login form on Safari browsers. The submit button becomes unresponsive after clicking, and no error message is displayed.

### Environment
- **OS:** macOS 13.2.1
- **Browser:** Safari 16.3
- **App Version:** 2.1.0
- **Device:** MacBook Pro M1

### Severity
- [x] Critical (System crash, data loss)
- [ ] High (Major feature broken)
- [ ] Medium (Feature partially broken)
- [ ] Low (Minor issue)

### Priority
- [x] Immediate (24h)
- [ ] High (3 days)
- [ ] Medium (1 week)
- [ ] Low (2 weeks)

## Steps to Reproduce
1. Navigate to https://app.example.com/login
2. Enter valid email and password
3. Click the "Sign In" button
4. Observe that nothing happens

## Expected Behavior
The form should submit, and upon successful authentication, redirect to the dashboard.

## Actual Behavior
The form does not submit. The button becomes unresponsive with no visual feedback or error message.

## Error Information
### Console Output

TypeError: Cannot read property 'preventDefault' of undefined at HTMLFormElement.handleSubmit (login.js:24) at HTMLFormElement.submit (login.js:12)


### Network Tab
No network requests are made when clicking the submit button.

## Additional Context
### Screenshots
![Login Form Error](path/to/screenshot.png)

### Video Recording
[Login Error Screen Recording](link/to/video)

### Related Issues
- Issue #234: Similar form submission issue on Firefox
- Issue #156: Event handler bugs in Safari

## Debug Information
### Code Version
```bash
git rev-parse HEAD
a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9

Dependencies​

{
  "react": "18.2.0",
  "react-dom": "18.2.0",
  "formik": "2.4.5",
  "yup": "1.3.2"
}

Impact​

Affected Users​

  • All Users
  • Specific User Group: Safari Browser Users
  • Single User

Business Impact​

Users on Safari (approximately 15% of our user base) cannot log in to the application, resulting in support tickets and potential loss of business.

Workaround​

Users can temporarily use Chrome or Firefox browsers until the issue is resolved.

Investigation Notes​

Attempted Solutions​

  1. Cleared browser cache and cookies
  2. Tested with different Safari versions
  3. Checked for JavaScript conflicts
  4. Verified form event binding

Debugging Steps​

  1. Added console logs to track form submission flow
  2. Inspected event listeners in Safari debugger
  3. Tested form submission with different event handling approaches