etc/furnace
0
0
Fork 0
mirror of https://github.com/tildearrow/furnace.git synced 2024-11-02 02:52:40 +00:00
Code Issues Projects Releases Packages Wiki Activity
furnace/.github/issue_template.md
tildearrow d77fd770f4 5E01: fix 12xx
2024-03-21 13:43:14 -05:00

2.8 KiB
Raw Blame History

EXTREMELY IMPORTANT NOTICE - PLEASE READ!!!!!!!

BY SUBMITTING AN ISSUE, YOU HEREBY AGREE TO COMPLY WITH THESE TERMS. FAILURE TO DO SO MAY RESULT IN YOUR ISSUE BEING DECLARED VOID.

ADDITIONALLY, FAILURE TO COMPLY WITH POINTS 1 AND 2 WILL RESULT IN THE INABILITY TO ISSUE FURTHER ISSUE REPORTS.

  1. this section is exclusively for ISSUES related to Furnace (bugs, major annoyances and others). ONLY THINGS THAT COUNT AS ISSUES (ad pedem litterae).
  2. THIS SECTION IS NOT FOR SUGGESTIONS, REQUESTS, QUESTIONS, SHOWCASE OR ANY OTHER DISCUSSIONS THAT DO NOT MEET THE CRITERIA AND DEFINITION OF AN ISSUE.
  • see the Discussions section if you wish to submit these.
  1. check whether your issue has been reported already.
  • go to the Issues section, and use the search bar that appears on top of the Issues list.
  1. include the following information:
  • version of Furnace (help > about)
  • operating system (and version)
  • whether you have downloaded Furnace, or built it from source.
  1. provide these details if you believe the issue is operating system and/or computer-specific:
  • CPU model
    • Windows: go to Control Panel > System.
    • macOS: go to the Apple menu and select About This Mac...
    • Linux: use lscpu or cat /proc/cpuinfo.
  • graphics card (and driver version)
    • Windows: open dxdiag and observe the Render tab.
    • macOS: go to the Apple menu and select About This Mac...
      • this information is not always shown.
      • this information is not necessary if you use an Apple silicon Mac.
    • Linux: use glxinfo | grep OpenGL.
  1. if your issue is an abnormal program termination (a "Crash"), you must provide additional details:
  • the furnace_crash.txt file that is created by Furnace after a Crash. this file is located in the following paths:
    • Windows: C:\Users\<username>\furnace_crash.txt
    • Linux/other: /tmp/furnace_crash.txt
    • on macOS this file is not generated. you may retrieve information about the Crash by clicking on "Report..." or "Show Details" in the "quit unexpectedly" dialog that appears following the Crash.
      • make sure to remove any personal information for privacy reasons.
      • be sure to select "Don't Send" afterwards.
  • the furnace.log file located in:
    • Windows: C:\Users\<username>\AppData\Roaming\furnace\furnace.log
    • macOS: ~/Library/Application Support/furnace/furnace.log
    • Linux: ~/.config/furnace/furnace.log
    • make sure to remove any personal information for privacy reasons.

BY SUBMITTING AN ISSUE, YOU HEREBY AGREE TO COMPLY WITH THESE TERMS. FAILURE TO DO SO MAY RESULT IN YOUR ISSUE BEING DECLARED VOID.

ADDITIONALLY, FAILURE TO COMPLY WITH POINTS 1 AND 2 WILL RESULT IN THE INABILITY TO ISSUE FURTHER ISSUE REPORTS.

END OF NOTICE PLEASE REMOVE THIS NOTICE AFTER READING. FAILURE TO REMOVE THIS NOTICE IS NEGLIGENCE.