Skip to content

Add bug reporting guidance for users #33

@BP602

Description

@BP602

Problem

KickTalk currently has no clear guidance for users on where to report bugs or provide feedback. This is especially important given that the project is in early development and users are likely to encounter bugs.

Expected Behavior

Users should have clear, accessible guidance on where and how to report issues they encounter while using the application.

Current Behavior

  • No bug reporting mechanism within the app
  • About section only shows developer social links
  • Users have to guess where to report issues

Proposed Solutions

Option 1: Add to About Section

Add a "Report Issues" section in the About dialog with links to:

  • GitHub Issues (primary)
  • Discord server (if available)
  • Clear instructions on what information to include

Option 2: Help Menu Item

Add a "Report Bug" option to the app menu/settings that opens:

  • GitHub issues page
  • Pre-filled issue template
  • Discord invite link

Option 3: In-App Bug Reporter

More advanced solution for future consideration:

  • Built-in bug report form
  • Automatically includes system info, logs, etc.
  • Submits directly to GitHub or Discord

Implementation Details

For quick implementation, recommend adding to the About section:

<div className="settingsContentSection">
  <div className="settingsContentHeader">
    <h5>Found a Bug?</h5>
  </div>
  <div className="settingsContentAboutAppContent">
    <p>KickTalk is in early development. If you encounter issues:</p>
    <div className="settingsContentAboutDevSocials">
      <a href="https://github.com/KickTalkOrg/KickTalk/issues" target="_blank">
        <span>Report on GitHub</span>
      </a>
      <a href="[DISCORD_INVITE]" target="_blank">
        <span>Join Discord</span>
      </a>
    </div>
  </div>
</div>

Acceptance Criteria

  • Clear guidance on where to report bugs
  • Easy access from within the application
  • Links to appropriate reporting channels (GitHub/Discord)
  • Instructions on what information to include in reports
  • Consider adding system info collection helper

Priority

This should be implemented soon given the early stage of the project and likelihood of user-reported issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions