Writing a proper GitHub issue

[rifandani]

Here is some summary how to write a proper Github issue from Andy Cochran:

1. Avoid duplication 1️⃣

Make sure your issue doesn’t already exist.

2. One issue per issue 2️⃣

Avoid issue that describe too much.
Each bug or feature request should be documented in its own issue.

3. Titles are important 3️⃣

Keep your titles short and descriptive.
Don’t try to cram every bit of information in the title.
More importantly, titles should also be compelling.
When someone reads your issue, they should want to work on it.
The title sells the issue.

4. Formatting issue 4️⃣

Markdown is a simple way to style your text on GitHub.
A well-formatted issue is easier to read, which helps the reader to focus and understand the content.

5. Objectivity 5️⃣

A good issue avoids speculation and opinion.
When describing a bug, be thorough.
When requesting features and changes, clearly describe the problem to be solved instead of prescribing a solution.

7. Reproduction steps 7️⃣

If you’re logging a bug you’ve observed, provide instructions to reproduce the bug.
Be precise in your instructions.