DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» is a community of 966,904 amazing developers

We're a place where coders share, stay up-to-date and grow their careers.

Create account Log in
Ben Halpern
Ben Halpern

Posted on

What are some tips for writing a good issue?

Top comments (4)

Collapse
 
ahferroin7 profile image
Austin S. Hemmelgarn

If there's an issue template, follow the damn thing.

This is seriously my number one complaint as someone who triages issues for Netdata. We have a set of issue templates, but it's not unusual for somebody who isn't part of the team and can't prove that it makes sense to just nuke the template and write a free-form issue description, and then I (or whoever else is triaging the issue) end up having to go back and forth with the person who reported the issue half a dozen times just to get the info we would have had if they had followed the issue template.

Collapse
 
thomasbnt profile image
Thomas Bnt

A short explanation that serves as a TLDR. And a long detailed one, but let it be spaced out and simply readable.

Collapse
 
aleksandrhovhannisyan profile image
Aleksandr Hovhannisyan

Use more screenshots/screencasts!

Collapse
 
ben profile image
Ben Halpern Author

Good point

Update Your DEV Experience Level:

Settings

Go to your customization settings to nudge your home feed to show content more relevant to your developer experience level. πŸ›