From cf767f38b6c354a9662959c00e4349b8b5815eb7 Mon Sep 17 00:00:00 2001 From: Victor Hall Date: Sun, 12 Mar 2023 13:45:00 -0400 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 34 ++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a4b3da3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: For bugs that are NOT ERRORS +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**If you are getting an error, use the ERROR template, not this BUG template. ** + +**To Reproduce** +Steps to reproduce the undesired behavior: +1. Configure training in this way (please attach _cfg.json) +2. Execute training with "this" command + +**Describe expected behavior and actual behavior** +ex. It does XYZ but should do ABC instead +ex. It does not do ABC when it should do ABC +ex. It should not do XYZ at all + +**Describe why you think this is a bug** +It should do ABC because... XYZ is wrong because... + +**Attach log and cfg** +*PLEASE* attach the ".log" and "_cfg.json" from your logs folder for the run. These are in the "logs" folder under "project_name_timestamp" subfolder. This will assist greatly in identifying problems with configurations or system problems that may be causing your problems. + +**Runtime environment (please complete the following information):** + - OS: [e.g. Windows 10, Ubuntu Linux 22.04, etc] + - Is this your local computer or a cloud host? Please list the cloud host (Vast, Google Colab, etc) + - GPU [e.g. 3090 24GB, A100 40GB, 2080 Ti 11GB, etc] + +**Additional context** +Add any other context about the problem here.