From 93e802afc28ba7dce87bd904a5bb6b7dba54fe6b Mon Sep 17 00:00:00 2001 From: Ethan Harris Date: Thu, 29 Sep 2022 17:49:45 +0100 Subject: [PATCH] Simplify bug report template (#14925) Co-authored-by: Rohit Gupta Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/1_bug_report.yaml | 62 +++++++++++++----------- 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml index 315f965e46..56076a62e4 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -1,52 +1,47 @@ name: Report a bug description: Any errors that are not UI related. -labels: ["needs triage", "bug"] +labels: ["needs triage"] body: - type: markdown attributes: value: > - WAIT! - Before you go any further. Is this really a **🐛 bug**? If it's a question about how Lightning works, have a look at our [Lightning documentation](https://lightning.ai/lightning-docs/) or ask a question on our [Community Slack](https://pytorch-lightning.slack.com). - If it really is a **🐛 bug**, please fill out this form as completely as you can. - - - type: checkboxes - id: checks - attributes: - label: First check - description: Please confirm and check all the following options. - options: - - label: I'm sure this is a bug. - required: true - - label: I've added a descriptive title to this bug. - required: true - - label: I've provided clear instructions on how to reproduce the bug. - required: true - - label: I've added a code sample. - required: true - - label: I've provided any other important info that is required. - required: true - - type: textarea attributes: label: Bug description - description: A clear and concise description of the 🐛bug🐛. + description: A description of the 🐛bug🐛. + placeholder: | + A clear and concise description of what the bug is. + + Include steps to reproduce, the expected behaviour, and the actual behaviour. + + ``` + The error message you got, with the full traceback if available. + ``` + validations: required: true + - type: markdown + attributes: + value: "**Note: The rest of this form is optional, but filling it out may help us to provide better support.**" + - type: textarea attributes: label: How to reproduce the bug description: > Provide steps and example code here. - placeholder: "# Insert code here" + placeholder: | + ```python + # Sample code to reproduce the problem + ``` render: python validations: - required: true + required: false - type: textarea attributes: @@ -65,9 +60,18 @@ body: - type: textarea attributes: - label: Important info - description: > - Provide all the following info + label: Environment + description: | + Please provide details about your enviornment by copying and pasting the output from our environment collection script: + https://raw.githubusercontent.com/Lightning-AI/lightning/master/requirements/collect_env_details.py + (For security purposes, please check the contents of the script before running it) + You can get the script and run it with: + ```console + wget https://raw.githubusercontent.com/Lightning-AI/lightning/master/requirements/collect_env_details.py + python collect_env_details.py + ``` + + You can also fill out the list below manually. value: | ``` @@ -84,7 +88,7 @@ body: ``` validations: - required: true + required: false - type: textarea attributes: