Skip to content
This repository has been archived by the owner on Jun 10, 2023. It is now read-only.

Issue Template

Gyrfalcon5 edited this page Jul 21, 2018 · 1 revision

Your issue may already be reported! Please search on the Issue tracker before creating one.

Expected Behavior

  • If you're describing a bug, tell us what should happen.
  • If you're suggesting a change/improvement, tell us how it should work.

Current Behavior

  • If describing a bug, tell us what happens instead of the expected behavior.
  • If suggesting a change/improvement, explain the difference from current behavior.

Possible Solution

  • Not obligatory, but suggest a fix/reason for the bug or ideas how to implement the addition or change.

Steps to Reproduce (for bugs)

  • Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant.
  1. Step 1
  2. Step 2
  3. Step 3
  4. Step 4

Context

  • How has this issue affected you? What are you trying to accomplish?
  • Providing context helps us come up with a solution that is most useful in the real world.

Your Environment

  • Include as many relevant details about the environment you experienced the bug in:
    • Version used:
    • Compiler used:
    • Operating System and version (desktop or mobile)