What is the right way to raise issue here?

You may have heard such a joke about programmers:

If you tell a programmer that there is a bug in your code, the programmer's first reaction may be: "Is your environment right? Do you understand how to use my code? Do you have any brain problems?"

But if you slightly modify the words, without, of cause, weakening the original theme of the content, shift the focus from the programmer to the specific code behavior, and say to him: "There are some behaviors in your code that are not consistent with the expected behaviors." Then they will immediately start to reflect on themselves: "WTF?! Is there a bug in my code?"

The core of the joke is not funny

This is indeed a very funny joke, which brings the programmer's sluggish reaction to the fullest. But the core of this joke is a sad fact: programmers are also humans, and humans always make mistakes.

So, although we have put all our efforts to make the deployed code not contain any bug, it will always inevitably have bugs, because we are also humans.

Not offensive

When you submit bug feedback, please remember that in another place on the earth, behind the screen, there is also a human who the programmer facing the feedback ticket you submitted. Imagine how you would talk to a stranger you never knew in reality. Not offensive, right?

For programmers, a "not offensive" feedback ticket means that the feedback ticket contains a complete description of the user environment, the reproduction steps can guide the programmer to complete the bug described in the ticket step by step, etc.

We don’t like "offensive"

Imagine such a scene, suppose you are called Hugo Jiang. One day, someone suddenly sent you a link on a social platform (QQ/Wechat/Telegram/Slack/Facebook). You can only preview the title of this link: Shock! Hugo Jiang actually had such a physical defect and he didn't know it! To view the detailed content, you need to click the link and jump to the corresponding website to view. Out of courtesy, you clicked on this link, only to find that it was actually an empty page with only a title, and the content was "No description provided." I think at this time you should realize that this is a prank, even feel angry.

Similarly, submitting such an issue with an empty title and no description to an open source code repository will immediately arouse strong resentment from the author/maintainer. Because this behavior is full of disrespect for the fruits of other people's labor, as well as for the energy and spare time of others.

Good sample

That said, let’s take a look at what is a good feedback ticket

• Title: as simple and understandable as possible, describe the problem in simple and precise words
• Explain the use environment: it should include the version of the user's system, the hardware used, etc., and even the files, codes, etc. that will cause problems
• Describe the reproduction steps: describe in as concise language as possible: how to reproduce this bug step by step
• Additional description of the problem: it may contain some usage details, other related configurations, etc.