From a025d042f56561812172a1f6b2ae6848ad914767 Mon Sep 17 00:00:00 2001 From: Philip A Cook Date: Tue, 21 Jan 2020 10:31:32 -0500 Subject: [PATCH] DOC: Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++++++++- .github/ISSUE_TEMPLATE/build_errors.md | 10 +++++++++- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c94689abe..04056a069 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,6 +4,25 @@ about: Report errors or unexpected results when running ANTs programs --- +Before opening an issue, please check the ANTs wiki: + +https://github.com/ANTsX/ANTs/wiki + +The Github wiki search only covers page titles, but you can do a full +text search by entering into Google: + +``` + site:https://github.com/ANTsX/ANTs/wiki +``` + +Please check previous issues on Github at + +https://github.com/ANTsX/ANTs/issues + +``` +is:issue +``` + **Describe the bug** A clear and concise description of what the bug is. @@ -27,7 +46,13 @@ If applicable, add screenshots to help explain your problem. **System information (please complete the following information)** - OS: [e.g. Mac OS] - OS version: [e.g. 10.15.1] - - Type of system: [Desktop, laptop, HPC cluster, cloud instance, other] + - Type of system: [Desktop, laptop, HPC cluster, cloud instance, + other] + + If you are building inside a virtual machine, container, Cygwin, + Windows Subsystem for Linux, or other non-native environment, please + let us know and include details of both the virtual Linux and the + host OS. **ANTs version information** - ANTs code version: [output of antsRegistration --version] diff --git a/.github/ISSUE_TEMPLATE/build_errors.md b/.github/ISSUE_TEMPLATE/build_errors.md index 41902f631..0336a947c 100644 --- a/.github/ISSUE_TEMPLATE/build_errors.md +++ b/.github/ISSUE_TEMPLATE/build_errors.md @@ -23,7 +23,15 @@ Superbuild and let us know if that compiles successfully. [ ] Installation (make install) **Build environment** - - OS name and version: [e.g. Ubuntu 18.04] + - OS: [e.g. Mac OS] + - OS version: [e.g. 10.15.1] + - Type of system: [Desktop, laptop, HPC cluster, cloud instance, + other] + + If you are building inside a virtual machine, container, Cygwin, + Windows Subsystem for Linux, or other non-native environment, please + let us know and include details of both the virtual Linux and the + host OS. **ANTs version** Specify the release tag or commit hash of the code you are building