Skip to content

Reporting Errors & Issues

If you encounter any errors, bugs, or issues while using the Shopping List App, please report them on our GitHub repository. Your feedback helps us identify and fix problems quickly.

How to Report an Issue

1. Visit Our GitHub Repository

Go to the ShoppingListApp GitHub repository: https://github.com/Evanlab02/ShoppingListApp

2. Create a New Issue

  1. Click on the "Issues" tab in the repository
  2. Click the "New Issue" button
  3. Choose the appropriate issue template or create a blank issue

3. Provide Detailed Information

When reporting an error or bug, please include the following information:

Required Information

  • Error Description: Clearly describe what went wrong
  • Steps to Reproduce: List the exact steps that led to the error
  • Expected Behavior: Describe what you expected to happen
  • Actual Behavior: Describe what actually happened instead

Additional Helpful Information

  • Error Message: Include any error messages you received (screenshots are helpful)
  • Browser Information: Your browser type and version (e.g., Chrome 120, Firefox 119)
  • Device Information: Your operating system (e.g., Windows 11, macOS 14, Ubuntu 22.04)
  • Time of Error: When the error occurred
  • User Account: Whether you were logged in or not (don't include passwords or sensitive data)

Issue Template Example

**Bug Description**
Brief description of the issue

**Steps to Reproduce**
1. Go to '...'
2. Click on '...'
3. Fill in '...'
4. See error

**Expected Behavior**
A clear description of what you expected to happen.

**Actual Behavior**
A clear description of what actually happened.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment**
- Browser: [e.g. Chrome 120]
- OS: [e.g. Windows 11]
- Device: [e.g. Desktop, Mobile]

**Additional Context**
Add any other context about the problem here.

Types of Issues You Can Report

🐛 Bug Reports

  • Application errors or crashes
  • Features not working as expected
  • Performance issues
  • Security vulnerabilities
  • Data loss or corruption issues
  • UI/UX problems and inconsistencies

📖 Documentation Issues

  • Unclear or missing documentation
  • Outdated information
  • Typos or formatting problems
  • Missing examples or tutorials

❓ Questions & Support

  • How-to questions
  • Usage clarification
  • General support requests
  • Configuration help

Before Reporting

Check Existing Issues

Before creating a new issue, please:

  1. Search existing issues to see if your problem has already been reported
  2. Check closed issues to see if the problem was previously resolved
  3. Review recent releases for any known issues or fixes

Try Basic Troubleshooting

  • Clear your browser cache and cookies
  • Try using a different browser
  • Check your internet connection
  • Refresh the page and try again
  • Disable browser extensions temporarily

Getting Started with GitHub

Don't Have a GitHub Account?

  1. Visit github.com
  2. Click "Sign up"
  3. Create your free account
  4. Verify your email address

New to GitHub Issues?

GitHub Issues is a simple way to track bugs and other project tasks. No technical knowledge is required - just describe your problem clearly.

Tips for Effective Bug Reports

  • Be Specific: Provide detailed, actionable information
  • Be Respectful: Remember there are real people working on this project
  • Be Patient: Investigation and fixes take time
  • Stay Engaged: Respond to questions and provide additional information when requested

Contributing Beyond Issue Reports

If you're interested in contributing code fixes or improvements:

  1. Fork the repository to your GitHub account
  2. Create a branch for your changes
  3. Submit a pull request with your proposed changes
  4. Follow our contribution guidelines (see CONTRIBUTING.md in the repository)

Contact Information

Thank you for helping us improve the Shopping List App by reporting bugs and issues!