Guideline: Read this before creating a new issue!

[dw-0]

What?

In the future, I will reserve the right to close issues whose forms have been inadequately filled out and do not contain at least very basic information about or where the problem occurred.

Why?

The issue form is intended to be filled out conscientiously in order to provide basic information at the beginning of every issue report. This way problems can be analyzed and (hopefully) solved more quickly or at least provide a good foundation for further troubleshooting and/or debugging. Inadequately filled out forms waste time for both, the help-seeking and helper party. For best success rates of solving an issue, giving concise but precise information is beneficial.

What does "inadequately" means now?

An issue form is inadequately filled out if:

• no Linux distribution was specified in the "Linux Distribution" form input field
  • not all Linux distributions behave the same, some distributions might need dedicated operations to make something work. Therefore it is important to tell, what distribution is used.
• vacuous description of how the issue occurred in the "What happened" form input field
  • e.g. do not simply copy and paste a random error message without describing which event it originates from
• vacuous description in the "What did you expect to happen" form input field of the desired outcome
  • at the time of writing an issue, only you, the user knows what your desired outcome is. This field is for describing what your wanted KIAUH to achieve.
• vacuous description of how to reproduce the issue in the "How to reproduce" form input field

Below, i made an attempt to provide examples for an inadequately and adequately answers to each input field. As those are just examples, they might not be very accurate and should just serve as a rough guideline on what rather not to write and what write instead.

Example of inadequate answers

Linux Distribution

• Linux
• Raspberry Pi
• My Laptop

What happened

• install of x, y, z not working
• <random error message>

What did you expect to happen

• don't see any issues
• normal install
• everything working

How to reproduce

• Just install KIAUH
• Just use KIAUH
• Just do x, y, z

Example of adequate answers

Linux Distribution

• Raspberry Pi OS (version)
• MainsailOS (version)
• FluiddPi (version)
• Ubuntu (version)

What happened

• During the installation of Moonraker, the following error message appeared <error message>
• After the installation of Klipper, Klipper is not starting/working
• Mainsail seems to not load, although the setup completed without visible errors

What did you expect to happen

• After the installation of Mainsail, i expected it to successfully load when opening Mainsail in the browser

How to reproduce

• First, i did x, then i did y, after that z happend and i did a, at the end the mentioned issue occurred