What essential information should always be included in a good Bug Report/Issue?

[Ridhsuki]

Hey community,

To help fix bugs and implement features faster, I want to create a clear and simple Issue Template for our repository.

In your experience, what are the absolute must-have details that someone should include when opening a new issue or reporting a bug?

[lumierexx]

From my experience, the best issue reports are the ones that let someone reproduce the problem without asking for more information.

For bug reports, I think these are the essentials:

A clear and descriptive title.
A short description of the problem.
Steps to reproduce the issue.
Expected behavior vs. actual behavior.
Screenshots or logs if they're helpful.
Environment details (OS, browser, language/runtime version, etc.).

If it's a feature request, I'd also like to see:

The problem the feature is trying to solve.
The proposed solution (if the reporter has one).
Any alternatives that were considered.

My general rule is: include enough information so another contributor can reproduce the issue on their own. That saves a lot of back-and-forth and usually leads to faster fixes.

[Ridhsuki]

Thanks for sharing