From 87ac42e09ff35f8bd696964c1b098a8b1ed8167b Mon Sep 17 00:00:00 2001 From: Dinesh Date: Thu, 15 Apr 2021 17:35:00 +0530 Subject: [PATCH] 'issue-template' Signed-off-by: Dinesh --- .github/ISSUE_TEMPLATE/Bug.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Documentation.md | 7 +++++ .github/ISSUE_TEMPLATE/Feature_Request.md | 21 +++++++++++++ ISSUE_TEMPLATE.md | 10 ------ 4 files changed, 65 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug.md create mode 100644 .github/ISSUE_TEMPLATE/Documentation.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_Request.md delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md new file mode 100644 index 00000000..cb3ba814 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -0,0 +1,37 @@ +--- +name: '🐛 Bug ' +about: Report a Bug +title: '' +labels: bug +assignees: '' + +--- + +## Instructions To Reproduce the 🐛 Bug: + +1.Describe the bug
+* A clear and concise description of what the bug is. +* Check the Develop Console tab and copy any error text there might be: https://scancode-workbench.readthedocs.io/en/develop/basics/check_for_errors_in_the_developer_tools.html + +2.Steps to reproduce the behavior
+* Go to '...'
+* Click on '....'
+* Scroll down to '....'
+* See error + +3.Expected behavior
+* A clear and concise description of what you expected to happen. + +4.Actual behavior
+* A clear and concise description of what actually happened. + +5.Screenshots
+* Add screenshots to help explain your problem, if applicable. + +6.OS and Vesrion
+* What OS are you running on? (Windows/MacOS/Linux) +* What version of scancode-workbench are you running on? +* What version of scancode-toolkit was used to generate the scan file? + +7.Additional context
+* Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Documentation.md b/.github/ISSUE_TEMPLATE/Documentation.md new file mode 100644 index 00000000..258732f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Documentation.md @@ -0,0 +1,7 @@ +--- +name: Documentation +about: Report a documentation issue +title: '' +labels: documentation +assignees: '' +--- \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md new file mode 100644 index 00000000..bc05f090 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_Request.md @@ -0,0 +1,21 @@ +--- +name: '🚀 Feature request' +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + + +--- + +## 🚀 Feature +* A clear and concise description of the feature proposal. + +## Motivation & Examples + +* Tell us why the feature is useful. + +* Describe what the feature would look like, if it is implemented.
+* Best demonstrated using **code examples** in addition to words. \ No newline at end of file diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 4fdd707f..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,10 +0,0 @@ -### Description -Please leave a brief discription of the bug or feature request: -* if reporting a bug, tell us how to reproduce the issue. -* Check the Develop Console tab and copy any error text there might be: https://scancode-workbench.readthedocs.io/en/develop/basics/check_for_errors_in_the_developer_tools.html - -### System configuration -For bug reports, it really helps us to know: -* What OS are you running on? (Windows/MacOS/Linux) -* What version of scancode-workbench are you running on? -* What version of scancode-toolkit was used to generate the scan file?