Add bug report issue template - Githubissues

trentm / python-markdown2

markdown2: A fast and complete implementation of Markdown in Python

Other

2.64k stars 431 forks source link

Add bug report issue template #516

Closed Crozzers closed 1 year ago

Crozzers commented 1 year ago

This PR adds a bug report issue template to help produce better bug reports.

The template requests a few specific things from users that I have found to be helpful when fixing issues:

Clear description of bug + expected behaviour
A markdown snippet inside a fenced code blocks (to escape GitHub's formatting)
- Included instructions on how to escape fenced code blocks inside the markdown snippet
Version of library in use + any extras

Let me know if I've missed any useful info that should be included

nicholasserra commented 1 year ago

Good call, thanks!