diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2020-04-29 18:45:36 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-29 18:45:36 (GMT) |
commit | a267771b28e3165e95c061964598a607ac127b91 (patch) | |
tree | 45f7577f2d280ac58fbb973c4fbfae68ce3d60af /.github/ISSUE_TEMPLATE/report-a-bug-or-issue.md | |
parent | 0937faf2d168b64f5ccf55c1976bc045d5d12569 (diff) | |
download | Doxygen-a267771b28e3165e95c061964598a607ac127b91.zip Doxygen-a267771b28e3165e95c061964598a607ac127b91.tar.gz Doxygen-a267771b28e3165e95c061964598a607ac127b91.tar.bz2 |
Update issue templates
Diffstat (limited to '.github/ISSUE_TEMPLATE/report-a-bug-or-issue.md')
-rw-r--r-- | .github/ISSUE_TEMPLATE/report-a-bug-or-issue.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/report-a-bug-or-issue.md b/.github/ISSUE_TEMPLATE/report-a-bug-or-issue.md new file mode 100644 index 0000000..d328fe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-a-bug-or-issue.md @@ -0,0 +1,30 @@ +--- +name: Report a bug or issue +about: Create a report to help us improve doxygen +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +Describe what you see that (you think) is wrong. + +**Expected behavior** +Describe what you would have expected or think is correct. + +**Screenshots** +If useful, add screenshots to help explain your problem. + +**To Reproduce** +Attach a self contained example that allows us to reproduce the problem. +Such an example typically exist of some source code (can be dummy code) and a doxygen configuration file used (you can strip it using `doxygen -s -u`). After you verified the example demonstrates the problem, put it in a zip (or tarball) and attach it to the bug report. Try to avoid linking to external sources, since they might disappear in the future. + +**Version** +Mention the version of doxygen used (output of `doxygen --version`) and the platform on which you run doxygen (e.g. Windows 10, 64 bit). If you run doxygen under Linux please also mention the name and version of the distribution used (output of `lsb_release -a`) and mention if you compiled doxygen yourself or that you use a binary that comes with the distribution or from the doxygen website. + +**Stack trace** +If you encounter a crash and can build doxygen from sources yourself with debug info (`-DCMAKE_BUILD_TYPE=Debug`), a stack trace can be very helpful (especially if it is not possible to capture the problem in a small example that can be shared). + +**Additional context** +Add any other context about the problem here. |