From c54c5aa00c547f4f53ccaa3f0aa7ca89b33ae21b Mon Sep 17 00:00:00 2001 From: Anton Schwaighofer Date: Mon, 23 May 2022 15:04:04 +0100 Subject: [PATCH 1/4] issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 67 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++ .github/ISSUE_TEMPLATE/not_working.yml | 74 +++++++++++++++++++++++ 4 files changed, 173 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/not_working.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..d6e01bf1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,67 @@ +name: "\U0001F41B Bug Report" +description: If you are pretty sure you are getting a bug, please create a report to help us improve InnerEye-DeepLearning +labels: ["bug"] + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + id: summary + attributes: + label: Bug summary + description: Please provide 1-2 short sentences that succinctly describe the bug. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Code for reproduction + description: If possible, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). It will be automatically formatted. + placeholder: Your code here + render: Python + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual outcome + description: Please describe the outcome of running the above code. Paste any error messages in the section below, not here. + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Error messages + description: Please copy and paste any relevant log output. Paste the full error traceback, not just the last error. It will be automatically formatted. + placeholder: Your errors here + render: python-traceback + + - type: textarea + id: expected + attributes: + label: Expected outcome + description: Please provide a description (or visual example) of the expected outcome from the code snippet. + validations: + required: true + + - type: textarea + id: system + attributes: + label: System info + description: | + Please describe the operating system that you are using, your Conda environment (by running `conda env export`) + and the `git` commit hash (version) of the InnerEye toolbox that you are using. To get the latter, please run: + + ```shell + git rev-parse --short HEAD + ``` + placeholder: Your system info (OS version, InnerEye commit hash, Result of `conda env export`) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..271f61a99 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: ❓ Discussions tab + url: https://github.com/microsoft/InnerEye-DeepLearning/discussions/new + about: Ask and answer InnerEye-related questions or start a general discussion diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..26d117b34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: "\U0001F680 Feature Request" +about: Submit a proposal/request for a new InnerEye feature +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**🚀 Feature** + + +**Motivation** + + + +**Pitch** + + + +**Alternatives** + + + +**Additional context** + + diff --git a/.github/ISSUE_TEMPLATE/not_working.yml b/.github/ISSUE_TEMPLATE/not_working.yml new file mode 100644 index 000000000..523169c09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/not_working.yml @@ -0,0 +1,74 @@ +name: "\U00002757 Something is not working" +description: > + If something is not working as expected but you're not sure if it's a bug, + please follow the instructions in this template. + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the problem you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + id: summary + attributes: + label: Problem summary + description: Please provide 1-2 short sentences that succinctly describe the problem. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Code for reproduction + description: > + If possible, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). + It will be automatically formatted. + Here's another useful resource: [How To Ask Questions The Smart Way](http://www.catb.org/~esr/faqs/smart-questions.html). + placeholder: Your code here + render: Python + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual outcome + description: Please describe the outcome of running the above code. + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Error messages + description: > + Please copy and paste any relevant log output. + Paste the full error traceback, not just the last error. + placeholder: Your errors here + + - type: textarea + id: expected + attributes: + label: Expected outcome + description: > + Please provide a description (or visual example) of the expected outcome + from the code snippet. + validations: + required: true + + - type: textarea + id: system + attributes: + label: System info + description: | + Please describe the operating system that you are using, your Conda environment (by running `conda env export`) + and the `git` commit hash (version) of the InnerEye toolbox that you are using. To get the latter, please run: + + ```shell + git rev-parse --short HEAD + ``` + placeholder: Your system info (OS version, InnerEye commit hash, Result of `conda env export`) From 18ba5f51205779a37069384290fc97528d444896 Mon Sep 17 00:00:00 2001 From: Anton Schwaighofer Date: Mon, 23 May 2022 16:29:03 +0100 Subject: [PATCH 2/4] allowing blank issues --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/not_working.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d6e01bf1b..6f858abfa 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -23,7 +23,7 @@ body: id: reproduction attributes: label: Code for reproduction - description: If possible, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). It will be automatically formatted. + description: If applicable, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). It will be automatically formatted. placeholder: Your code here render: Python validations: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 271f61a99..da7c2ba5e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: ❓ Discussions tab url: https://github.com/microsoft/InnerEye-DeepLearning/discussions/new diff --git a/.github/ISSUE_TEMPLATE/not_working.yml b/.github/ISSUE_TEMPLATE/not_working.yml index 523169c09..460d78024 100644 --- a/.github/ISSUE_TEMPLATE/not_working.yml +++ b/.github/ISSUE_TEMPLATE/not_working.yml @@ -25,7 +25,7 @@ body: attributes: label: Code for reproduction description: > - If possible, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). + If applicable, please provide a [minimum self-contained example](https://stackoverflow.com/help/minimal-reproducible-example). It will be automatically formatted. Here's another useful resource: [How To Ask Questions The Smart Way](http://www.catb.org/~esr/faqs/smart-questions.html). placeholder: Your code here From b8361028c9bee1a95f8d0b1f0c20aaf8c2646fad Mon Sep 17 00:00:00 2001 From: Anton Schwaighofer Date: Tue, 24 May 2022 10:40:09 +0100 Subject: [PATCH 3/4] docu template --- .../ISSUE_TEMPLATE/documentation_issue.yml | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.yml diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.yml b/.github/ISSUE_TEMPLATE/documentation_issue.yml new file mode 100644 index 000000000..876993549 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_issue.yml @@ -0,0 +1,28 @@ +name: "\U0001F4D2 Documentation Problem" +description: If the documentation is unclear or missing information, please create a report to help us improve InnerEye-DeepLearning +labels: ["documentation"] + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the problem you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + id: summary + attributes: + label: Issue summary + description: Please provide 1-2 short sentences describing where the documentation should be improved. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What documentation should be provided? + description: Please provide a description of what information should be captured or corrected in the documentation. + validations: + required: true From fdeb547af1ab6b55ec895ec2ecacbd57e0553a2e Mon Sep 17 00:00:00 2001 From: Anton Schwaighofer Date: Tue, 24 May 2022 11:14:46 +0100 Subject: [PATCH 4/4] URL --- .github/ISSUE_TEMPLATE/documentation_issue.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.yml b/.github/ISSUE_TEMPLATE/documentation_issue.yml index 876993549..21e96bb01 100644 --- a/.github/ISSUE_TEMPLATE/documentation_issue.yml +++ b/.github/ISSUE_TEMPLATE/documentation_issue.yml @@ -15,7 +15,9 @@ body: id: summary attributes: label: Issue summary - description: Please provide 1-2 short sentences describing where the documentation should be improved. + description: Please provide 1-2 short sentences describing where the documentation should be improved. If applicable, + please provide the URL of the file that needs updating. + placeholder: Description of where an update is needed, URL of the file if possible. validations: required: true