Thanks for taking a stab at this.
I don’t think linking bad examples is appropriate. It might come across as shaming. It’s also negative reinforcement. From a psychological point of view, we want to focus on telling people how to do it right so that is what sticks in their head.
I’m not sure the best way to do edits without making a really long post, so I’m just going to add in what I think should be added. Which is just a revamp of the one section:
How to write a good question
Topic Description
Give the topic a descriptive title that captures the problem accurately - it’s the first thing people will see of your help topic. “Problem with CharacterBody2D” is a bad title, “CharacterBody2D doesn’t trigger collision during move_and_slide()” is better.
Use The Template
Use the help topic template - fill in the Godot version you’re using and any plugin versions as well.
Format Your Code
Post any code that is relevant. Resist the urge to only give the code you think is relative, and post the full script causing the problem. Please format your code correctly. Failing to do so will likely result in your first reply being a request to format your code. Do not post screenshots of code. These are hard to read on some devices, and also make it harder to get a good response. When your code is text and formatted correctly, they will often correct your code for you.
There are three ways to format code:
- Wrap it in 3 backticks (```) above and below the code to create a
code block. Adding “gd” after the top set will format your code as GDScript and make it even easier to read. - Press the Preformatted Text button (
) in the toolbar. This is the best option for people on Mobile devices, and people using non-English keyboards. Note you can still add “gd” at the end of top three backticks to make your code even easier to read. - Press Ctrl + E on your keyboard. This is the keyboard shortcut for option #2.
This:
```gd
#Paste your code here
```
Turns into this:
#Paste your code here
Describe Your Problem
Explain the problem you’re having in detail.
- What problem are you having? Tell us the problem you are trying to solve. Often people post the problem with the solution to the actual problem they’re having. In Godot, there are often simple solutions to complex problems. This is especially true if you are a programmer coming from another language, or you are getting advice from an LLM. This is known as the X-Y Problem.
- What do you expect to happen that is not? It may not be obvious to your readers what you think should happen. Tell us. also, do not assume that your reader has played the same games as you. Also don’t expect anyone to watch a 30 minute tutorial video to see where you went wrong.
- How / when did the problem arise? Was this working before? On an earlier version of Godot? Or before you made a change? Did you update your video drivers recently or make other changes to your computer?
- What steps have you taken to try and fix the problem? If you don’t want to get suggestions for a bunch of things you’ve already tried, tell us what you’ve done to try to fix the problem. Showing that you have spent time trying to solve the problem is more likely to get you more thoughtful responses in return.
- Copy and paste any errors you get in full. You can copy messages from the editor directly, and that gives us information to help you - even if it seems unimportant or nonsense to you.
- Add screenshots of your Scene Tree, Inspector and/or the whole Editor if you think it might be relevant. If you are new to the forum, you can make replies to your own post to add additional screenshots after the first. Do not try and recreate your Scene Tree in text. There are things we can see by the icon or color of an icon, warnings and other things that you may not notice but can help us solve your problem.
- Review your post. Before posting, re-read your question to make sure it’s clear and presentable - then hit Create Topic, lean back, and wait for help to arrive. If you later notice something that can be improved, you can edit your topic.