Skip to content

Instantly share code, notes, and snippets.

@mrbar42

mrbar42/README.md

Created November 28, 2018 17:28
Show Gist options
  • Save mrbar42/2d0671c59f4059969e5c32dd13cf5a79 to your computer and use it in GitHub Desktop.
Save mrbar42/2d0671c59f4059969e5c32dd13cf5a79 to your computer and use it in GitHub Desktop.
Download ZIP
How to open a Github issues like a pro
Raw
README.md

A Pro Example of a Github Issue

This issue is an overview about Github issues and their structure.

Detailed Description

There are many issues around software and development and many times despite a very good intention, the lack of information renders issues irrelevant and unaddressable.

This issue serves as an inspiration and as a practical example for info reach issue.

How to reproduce

To reproduce this issue follow the next steps:

  1. copy the raw markdown of this gist
  2. paste it in your repository
  3. replace the placeholders with your data
  4. profit!

I used Chrome 70 on Mac OS Mojave to write this issue.

raw information should not be inlined because it bloats the issue, instead use collapsed details block

Raw information

to include collapsed information use the following Markdown syntax

<details>
<summary></summary>

```
the newlines above and below this block are important
```

</details>

Additional side notes can be added in the bottom under a line that is added using three consecutive dashes ---

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment