aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2024-10-10 11:00:42 -0700
committerJohn MacFarlane <[email protected]>2024-10-10 11:00:42 -0700
commit32c1a31f61b012aaae784138fb2a049ccdd496ad (patch)
tree5b7905d0321947709d2d788883c1f8da40a33d44 /.github
parentc5bab883ec8ea64f5fe56f1fd6be66e31dd9a86a (diff)
Improve bug report template.
Suggest looking at changelog in case of regressions.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md25
1 files changed, 17 insertions, 8 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f53a163aa..14bb9da22 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,20 +7,29 @@ assignees: ''
---
<!--
-Thank you for reporting an issue! Before you continue, please make sure that you have
+Thank you for reporting an issue!
+Before you continue, please make sure that you have
-- searched the [issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (including closed issues).
-- searched the [discussion forum](https://github.com/jgm/pandoc/discussions) for
- solutions.
-- reproduced your issue on the [latest release of pandoc](https://github.com/jgm/pandoc/releases), or online at [try pandoc](https://pandoc.org/try).
+- reproduced your issue with the latest release of pandoc
+ (https://github.com/jgm/pandoc/releases), or online (https://pandoc.org/try).
+- searched the issue tracker (https://github.com/jgm/pandoc/issues)
+ for similar issues (including closed issues).
+- searched the discussion forum
+ (https://github.com/jgm/pandoc/discussions) for solutions.
+
+If you are experiencing a regression (an unwanted change of
+behavior from an earlier version of pandoc), please indicate
+this and give relevant version numbers. Be sure to check the
+release notes (https://pandoc.org/releases) for relevant
+changes, as you might find a solution there.
Note that this bug tracker is for reporting bugs, not asking
-questions. For questions, use the [discussion
-forum](https://github.com/jgm/pandoc/discussions).
+questions. For questions, use the discussion forum:
+https://github.com/jgm/pandoc/discussions.
-->
**Explain the problem.**
Include the **exact command line** you used and **all inputs necessary to reproduce the issue**. Please create as minimal an example as possible, to help the maintainers isolate the problem. Explain the output you received and how it differs from what you expected.
**Pandoc version?**
-What version of pandoc are you using, on what OS? (If it's not the latest release, please try with the latest release before reporting the issue.)
+What version of pandoc are you using, on what OS? (If it's not the latest release, please try with the latest release before reporting the issue. Note that many linux distributions have old versions of pandoc in their repositories.)