From 17d7cbe315868e881431b837532d0aa8dc3080db Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 12 Nov 2023 21:13:02 +0100 Subject: [PATCH 1/2] Try to make bug report instructions even more clear --- .github/ISSUE_TEMPLATE/bug_report.md | 60 ++++++++++++++++++---------- 1 file changed, 39 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cb4eb30a8d..9194f7027d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,29 +11,49 @@ assignees: '' IMPORTANT NOTE -------------- -Please note that this entry field uses [Markdown][1], which means that you -need to escape any code snippets pasted here using fenced code blocks, -i.e. by putting ``` before and after it. Also escape, using -backslash, i.e. `\<` any angle brackets to prevent them from being -interpreted as HTML tags. +Please note that this entry field uses Markdown, see -Use the Preview tab to review your issue before submitting it to verify that -your formatting is correct. +https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax -[1]: https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax +if you're unfamiliar with it, and make sure to use the "Preview" tab just above +to review your issue before submitting it to verify that your formatting is +correct. ---- +In particular, please use code blocks, i.e. put ``` on a separate line before +and after any block of code or long text (such as compiler or make output). + +Also make sure to escape, using backslash, i.e. `\<`, any angle brackets +to prevent them from being interpreted as HTML tags. + +Finally, feel free to remove the explanatory comments, including this one, +after reading (and hopefully following) them. + +--> + +### Description + -### Description - - ### Platform and version information - wxWidgets version you use: - wxWidgets port you use: - OS and its version: - - -+ GTK version: -+ Which GDK backend is used: -+ Current theme: + + + GTK version: + + Which GDK backend is used: + + Desktop environment : + + Current theme: From 12984a0ceb325a84612831d7ae88fe714b346c91 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 13 Nov 2023 01:55:46 +0100 Subject: [PATCH 2/2] Ask to specify the build system used in build problem template Also ask for any unusual compiler options. --- .github/ISSUE_TEMPLATE/build_problem.md | 27 +++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/build_problem.md b/.github/ISSUE_TEMPLATE/build_problem.md index 32ece1b26a..658b0f1b36 100644 --- a/.github/ISSUE_TEMPLATE/build_problem.md +++ b/.github/ISSUE_TEMPLATE/build_problem.md @@ -6,13 +6,31 @@ labels: 'build' assignees: '' --- + +### Build System Used + -Please attach the full build log, but feel free to quote the relevant parts of -it here. +I build wxWidgets and/or my application using: + +- [ ] CMake +- [ ] configure +- [ ] mingw32-make with makefile.gcc +- [ ] MSBuild (Microsoft Visual Studio solution file) +- [ ] nmake with makefile.vc +- [ ] Xcode + + you are building: - OS and its version: - Compiler being used: +- Non-default compiler options, if any :