Skip to content

How to Report Issues (Bugs, Feature Request and Help)

Zer0CoolX edited this page Apr 28, 2020 · 5 revisions

There are three (3) available templates for submitting an issue according to its nature.

If a submitted issue is not properly filled out, has an extremely small amount of information in it or has already been addressed in the wiki or other issues it is likely to be either ignored or closed without assistance.

Expectations Prior to Submitting

There are some expectations that you must meet prior to submitting an issue. Read all of the documentation in the wiki (it changes, sometimes rapidly). Read the other submitted issues and double check the steps you took in using the script. Ensure you have the latest build/version of the script (if you are unsure just download it again). Lastly, I can only help with matters related to using the stable source, not the gihub source (even if its the same numeric version of Guacamole).

Types of Issues

  1. Bug report - This should be used when you feel that the script has a flaw. If it is supposed to do something and does not. In other words a problem with how the script and its logic are written causing an undesirable result versus what the script is expected to do. This would be something that affects others with a similar setup and not a unique issue to a specific person. Ex: The script says it opened the firewall on port 80 but actually does not.
  2. Feature request - This is to suggest a feature or change to the script that is not currently incorporated or planned. This is for suggestions that would benefit the majority of people using the script, not a personal desire for a fringe capability. Ex: Upon completion displaying a message that says "complete!" so users know the script has finished running.
  3. Help request - This is to ask for help with a specific issue you are facing in implementing the script. This should be unrelated to how the script is written and instead be a product of how you are using the script. Ex: When I run the script and enter LDAP information the script completes but the web site loads to a blank page. Be aware that submitting a request for help does not mean that you will receive help.

IMPORTANT

When creating an issue, each template has a field for a title. This should be a brief, descriptive statement of the overall issue or idea. Ex: "[BUG] Firewall port 80 is not opened upon completion" or "[REQ] Add a Completion Message when Finished". The part in the square brackets "[]" will be pre-entered, leave it as is and simply enter your title to the right of the tag.

Each template includes questions to help me (and others) help you. Answer all of the questions to the best of your ability. In most cases, each question gives an example of the expected answer. Remove any of the example text before submitting the issue.

Be as complete and thorough as possible. The more relevant information you provide in the request the better able others and/or myself will be able to help and resolve issues.