Filling out a Bug Report

Using GitHub to fill out a bug report issue helps us to keep track of and implement fixes to issues that you may find in our application. This short guide will help you to understand what we are looking for when a user is filling out this template.

  • Title: Use a clear and descriptive title that summarizes the issue.

  • What Happened: Provide detailed information about how the problem.

    • Describe the behavior that you experienced

    • Specify the expected behavior.

  • Steps to reproduce the behavior:

    • Detail a step by step process that you followed which lead to the issue

    • Include any error messages

  • Priority: Assign a priority that you think matches the severity of the issue

  • Relevant log output: Include any log output that you have.

    • This is optional, if you do not know what log output is or where to get it, please leave blank

  • Labels: Select relevant labels to categorize the issue (e.g., bug, feature request, enhancement).

  • Screenshots and additional context: Embed any screenshots, gifs, or external video links that can help explain the issue you are experiencing.

  • Assignees: Optionally, assign the issue to specific team members if necessary.

Change log

Major updates to the content of this page will be added here.

DateUpdateNotes

2/12/2024

Initial Content

Updated with Initial content

Last updated