From 46cf54c02018f0d25d6761a84c7ffb3acd2ea3e7 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu Date: Thu, 23 Feb 2023 09:20:50 -0800 Subject: [PATCH 01/10] Add GH issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 47 +++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000000..625ec740808 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,47 @@ +name: Bug Report +description: Create a tutorial bug report + +body: +- type: markdown + attributes: + value: > + #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/pytorch/tutorials/issues?q=is%3Aissue+sort%3Acreated-desc+). +- type: textarea + attributes: + label: Describe the bug + description: | + **Link to the tutorial on the website:** + placeholder: | + Provide a detailed description of the issue with code samples if relevant + ```python + + # Sample code to reproduce the problem if relevant + ``` + + **Expected Result:** (Describe what you were expecting to see) + + + **Actual Result:** (Describe the result) + + ``` + The error message you got, with the full traceback. + ``` + + validations: + required: true +- type: textarea + attributes: + label: Describe your environment + description: | + **Describe your environment:** + + * Platform (i.e macOS, Linux, Google Colab): + * CUDA: + * PyTorch version (run `python -c "import torch; print(torch.__version__)"`): + + validations: + required: true +- type: markdown + attributes: + value: > + Thanks for contributing 🎉! From 152ae3789d95bbf38377be871598633fa673e35b Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu Date: Wed, 1 Mar 2023 12:02:17 -0800 Subject: [PATCH 02/10] Add the feature and bug report templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 ++++-- .github/ISSUE_TEMPLATE/feature-request.yml | 29 ++++++++++++++++++++++ 2 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 625ec740808..3c19a010ae8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,5 +1,9 @@ -name: Bug Report +name: 🐛 Bug Report description: Create a tutorial bug report +title: [BUG] - +labels: [ + "bug" +] body: - type: markdown @@ -36,7 +40,7 @@ body: **Describe your environment:** * Platform (i.e macOS, Linux, Google Colab): - * CUDA: + * CUDA (yes/no, version?): * PyTorch version (run `python -c "import torch; print(torch.__version__)"`): validations: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000000..a7007501f8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,29 @@ +name: 🚀 Feature request +description: Submit a proposal for a new PyTorch tutorial or improvement of an existing tutorial +title: "💡 [REQUEST] - <title>" +labels: [ + "feature" +] + +body: +- type: textarea + attributes: + label: 🚀 Descirbe the improvement or the new tutorial + description: > + Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. + validations: + required: true +- type: textarea + attributes: + label: Existing tutorials on this topic + description: > + List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere. +- type: textarea + attributes: + label: Additional context + description: > + Add any other context or screenshots about the feature request. +- type: markdown + attributes: + value: > + Thanks for contributing 🎉! From f31a0dbcf6752ad24a60f9c0bc9c16640c1803b4 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 13:33:25 -0800 Subject: [PATCH 03/10] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 3c19a010ae8..dda184a3475 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,6 @@ name: 🐛 Bug Report description: Create a tutorial bug report -title: [BUG] - <title> +title: "[BUG] - <title>" labels: [ "bug" ] From 86ca24268bca118df169ef3efa3aa6c7a6ad0207 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 13:36:03 -0800 Subject: [PATCH 04/10] Update feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index a7007501f8b..ec547edf8ed 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -9,19 +9,19 @@ body: - type: textarea attributes: label: 🚀 Descirbe the improvement or the new tutorial - description: > + description: | Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. validations: required: true - type: textarea attributes: label: Existing tutorials on this topic - description: > + description: | List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere. - type: textarea attributes: label: Additional context - description: > + description: | Add any other context or screenshots about the feature request. - type: markdown attributes: From ea137909b350c33e09e156cfd72dd2258613b43f Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 13:37:40 -0800 Subject: [PATCH 05/10] Update feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index ec547edf8ed..e7e07f53eda 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -10,18 +10,23 @@ body: attributes: label: 🚀 Descirbe the improvement or the new tutorial description: | - Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. + pleaceholder: | + Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. validations: required: true - type: textarea attributes: label: Existing tutorials on this topic description: | + pleaceholder: | List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere. + * Link + * Link - type: textarea attributes: label: Additional context description: | + pleaceholder: | Add any other context or screenshots about the feature request. - type: markdown attributes: From 023b53916fe13229d8e53b71ea06ac5c01ddd7e1 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 14:07:17 -0800 Subject: [PATCH 06/10] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index dda184a3475..d33e3109ff6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -38,7 +38,7 @@ body: label: Describe your environment description: | **Describe your environment:** - + placeholder: | * Platform (i.e macOS, Linux, Google Colab): * CUDA (yes/no, version?): * PyTorch version (run `python -c "import torch; print(torch.__version__)"`): From 578dcbdbb87364e12aff46ff0869b1282d139a9b Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 14:08:02 -0800 Subject: [PATCH 07/10] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index d33e3109ff6..4c1fd151735 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -38,7 +38,7 @@ body: label: Describe your environment description: | **Describe your environment:** - placeholder: | + placeholder: | * Platform (i.e macOS, Linux, Google Colab): * CUDA (yes/no, version?): * PyTorch version (run `python -c "import torch; print(torch.__version__)"`): From 003ffcd4869f5fb4d3104782644bbfd47b2207f6 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 14:08:43 -0800 Subject: [PATCH 08/10] Update feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index e7e07f53eda..3ea492df19e 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -10,15 +10,15 @@ body: attributes: label: 🚀 Descirbe the improvement or the new tutorial description: | - pleaceholder: | - Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. + placeholder: | + Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. validations: required: true - type: textarea attributes: label: Existing tutorials on this topic description: | - pleaceholder: | + placeholder: | List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere. * Link * Link @@ -26,7 +26,7 @@ body: attributes: label: Additional context description: | - pleaceholder: | + placeholder: | Add any other context or screenshots about the feature request. - type: markdown attributes: From 7a176c17ac3655de111e0c17bcf252f00fc85524 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Wed, 1 Mar 2023 14:10:13 -0800 Subject: [PATCH 09/10] Update feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 3ea492df19e..c4bd3bde3cf 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -10,6 +10,7 @@ body: attributes: label: 🚀 Descirbe the improvement or the new tutorial description: | + **Describe the improvement** placeholder: | Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here. validations: @@ -18,6 +19,7 @@ body: attributes: label: Existing tutorials on this topic description: | + **Add a list of existing tutorials on the same topic.** placeholder: | List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere. * Link @@ -26,6 +28,7 @@ body: attributes: label: Additional context description: | + **Add additional context** placeholder: | Add any other context or screenshots about the feature request. - type: markdown From d416f27c46d06a4e74017322a807449beb9b86d4 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu <svekars@fb.com> Date: Thu, 9 Mar 2023 08:52:41 -0800 Subject: [PATCH 10/10] Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Zain Rizvi <ZainRizvi@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 4c1fd151735..1078f20556e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -37,7 +37,7 @@ body: attributes: label: Describe your environment description: | - **Describe your environment:** + **Describe the environment you encountered the bug in:** placeholder: | * Platform (i.e macOS, Linux, Google Colab): * CUDA (yes/no, version?):