How To Ask For Assistance

How To Ask For Assistance

Use the following guide when asking for assistance.

Template For Assistance

Copy this block and edit as necessary. Paste the copied text to your thread. Keep the formatting. Only Edit [TEXT] (including the brackets). Highlight from starting [ to the ending ] and start editing/pasting.


* **Platform**
  * Hardware: [EDIT THIS]
  * Operating System: [EDIT THIS]
  * OpenHAB Version: [EDIT THIS]
  * Originating Issue: [Such as Binding, etc.]
* **Issue**
  * Expected Behavior: [What is the expected behavior?]
  * Actual Behavior: [What are you experiencing?]
  * Steps: (Steps to reproduce the issue)
    1. [STEP 1]
    2. [STEP 2]
    3. [STEP 3] 
* **What I have done so far**
  * [A]
  * [B]
  * [C]
* **Rule**
  ```
  [If you have a rule that isn't working, paste it here]
  ```
* **Details**
  * [Details here]
* **Logs**
  ```
  [HIGHLIGHT THIS AND PASTE YOUR LOGS]
  ```

Search For Issues Similar To Yours

OpenHAB is huge. More often than not, your issue is most likely already encounted by others and are already solved. Search the forum first:
Search

Be Detailed As Much As Possible

Add every detail you could think of to minimize back-and-forth between you and the community.

Avoid Asking For Help From Private Messages

We are an Open-Source community. If you ask a single person for help, then you’re really missing out on the Open Source mentality. Let others learn from your experince as well!

Avoid being spoon-fed

Only ask for help if you have done everything you can to solve the issue.

Helpful Links

1 Like

Creating this to reference this post for users asking for questions with minimal or missing information .

When a user creates a new topic in the Setup and Configuration section it automatically comes prepopulated with:

  • Platform information:
    • Hardware: CPUArchitecture/RAM/storage
    • OS: what OS is used and which version
    • Java Runtime Environment: which java platform is used and what version
    • openHAB version:
  • Issue of the topic: please be detailed explaining your issue
  • Please post configurations (if applicable):
    • Items configuration related to the issue
    • Sitemap configuration related to the issue
    • Rules code related to the issue
    • Services configuration related to the issue
  • If logs where generated please post these here using code fences:

I wish I had a dollar for every time someone has posted a new thread and all they changed was the subject and left all of the above empty.

A related thread: Beginner's Guide for Topic Creation

1 Like

Yes, that is correct, but is not happening.

Maybe this thread here could be added to said template.

@luckymallari nice idea!

1 Like