How to ask for software development help on the internet

Robert Colley — Sun, 23 Oct 2022 13:48:24 +0000

All too often, I see that there are tons of people who post comments like this:

What is wrong with this?

I mean no offense to this wonderful user, but there is nothing here that I can start helping out with. It is important to have a list of the steps you have taken to get to the point of this error in a detailed way. Often in software development, the order that commands are run can have a great impact on how the end result turns out. I don't know anything about the environment they are using other than they are using windows 11. There are so many softwares you can install that can mess up your local environment, that it is almost impossible to guess past just "windows 11"

For example:

$ run command abc
$ run command xyz

# Exit code 0 - success!

vs.

$ run command xyz
$ run command abc

# ERROR when running commands!

the two examples have a very different output. Let's look at the theoretical documentation for this set of commands:

# run command abc
Enables you to set up your workspace.

# run command xyz
Starts the application in your workspace. Depends on abc

What do you notice?

1. A better understanding of the commands by the developer could have avoided this problem

Developers need documentation to understand how to use the tools they posses. No one writes any public software without at least making a small attempt at conveying how to use it! If no one can understand your software, it will not be used.

Many software packages like React Native have excellent guides to getting started. Double and triple checking

2. This error could have been found with a google search

In big enough softwares, you are usually not the first person to come up with an issue. Searching the error message on google can usually be a great way to get started. Our friend here had this error:

3. Read the error message first

error Failed to install the app. Make sure you have the Android development environment set up:
https://reactnative.dev/docs/environment-setup.
Error: Command failed: gradlew.bat app:installDebug-PreactNativeDevServerPort=8081

First of all, React Native (and most softwares) knows what they need to run. It cannot run without certain parts of the environment set up. The error even gives a direct link to what you need to do to fix this issue.

Final thoughts

I believe the vast majority of people are only asking questions and not answering any questions. I challenge you to try and answer a question on any GitHub repo or subreddit you like! Answering questions can give you a better perspective and help teach you how to write your own questions!