#best-posting-practices

1 messages · Page 1 of 1 (latest)

frank orbit
#
  1. Search this Discord server for similar posts.
    Discord search isn't the most intuitive, so here are the steps to help guide you through this.
  • To search the contents of the forum threads, use the Global search feature.
    • On desktop, the search box is in the top right of the window - use the in:channel + keyword formatting.
    • On mobile, the global search box is at the very top of the channel list - search your keyword and look at the Messages results.
  • To search the post titles in forum channels, use the top search/create post bar of the respective support channel. It's good practice to search the posts with the ✅ Resolved tag - those posts may already have a solution for you.
    -# We also suggest to select the relevant tag to your situation to see if others have run into the same issue.
#
  1. Post your issue only in one channel.
    Crossposting in multiple channels reduces the efficiency in which the community can help. If the thread needs to be moved, a moderator can help you get in the right place.
#
  1. Patience is your best friend!
    Most who can help are doing this voluntarily and community experts for your specific issue may not be online when you post. Following the rest of these guidelines will help ensure those experts have everything they need to help you.
#
  1. Describe the goal, not the problem.
    The problem you run into may be the wrong way to attempt your goal, so explaining what you want to do first will allow others to understand where they can start helping you.
#
  1. A good title goes a long way...
    ...in describing what you are running into. Examples of good and bad titles are:
  • ✅ - How do I use a timer in an automation to delay an action?
  • ⚠️ - Timer not working
  • 🚫 - Problem/need help
  • ✅ - Not able to include device <model number>
  • ⚠️ - Device not discovered
  • 🚫 - ZWave problem
    -# Tags in the respective channels should help identify the specific tech problem you are running into.
#
  1. Select the appropriate tags for your issue.
    Each channel has their tags described in their respective Channel description thread, however there are general tags used in every support channel. These are:
  • 🟢 New to HA - Please use this tag if you are new to Home Assistant. This helps flag to the community that you aren't as experienced as they are.
  • Resolved - This tag should only be used when the thread opener's issue has been resolved. Either the OP or mods can amend this to the posts.
  • casita Official - Only used by employees at Nabu Casa. Sort by this to see official updates.
#
  1. Show what you've worked on/tried.
    Link to other threads or videos that may have helped you, or let the community know if you have used generative AI to help with your code (which is in general a bad practice). Describe the exact steps you tried and their results so the community doesn't ask you to try things you've already done.
#
  1. Format everything properly.
    YAML (and some other coding languages) rely heavily on whitespace. If you are sharing your code in your post, be sure to use triple ` (backticks) tags at the beginning and ending of your code snippet. Example - when you use the backticks followed by the language name, it will post with markdown colors for easier reading (on some Discord clients).
# Turn off lights when everybody leaves the house
  - alias: 'Rule 2 - Away Mode'
    trigger:
      platform: state
      entity_id: group.all_devices
      to: 'not_home'
    action:
      service: light.turn_off
      entity_id: group.all_lights```
If you want things to be tidy and feel that your message may be too long (for example, your code or logs have 20 lines or more), we highly suggest using <https://dpaste.org/> or <https://paste.debian.net/> to share code or logs in your post.
-#  * Being familiar with [Discord Markdown Text](<https://support.discord.com/hc/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline>) in general will help you format your messages.