From 238813efe147475dcadb032dc8e67d731900d6ed Mon Sep 17 00:00:00 2001 From: Felix-Ayush <67006255+Ayush7614@users.noreply.github.com> Date: Sun, 20 Mar 2022 00:36:07 +0530 Subject: [PATCH] chore : added issue templates and PR templates (#128) Co-authored-by: Aniket Singh --- .github/ISSUE_TEMPLATE/Other.md | 6 ++++ .github/ISSUE_TEMPLATE/bug-report.yml | 36 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation-update.yml | 29 +++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 25 +++++++++++++ .github/ISSUE_TEMPLATE/user-feedback.yml | 25 +++++++++++++ 5 files changed, 121 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/Other.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation-update.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/user-feedback.yml diff --git a/.github/ISSUE_TEMPLATE/Other.md b/.github/ISSUE_TEMPLATE/Other.md new file mode 100644 index 00000000..cb3be9b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Other.md @@ -0,0 +1,6 @@ +--- +name: Other +about: Something else + +--- + diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..a03e0192 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,36 @@ +name: Bug Report +description: Create a report to help us improve +title: "Bug: " +labels: [bug] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Bug report. + - type: textarea + attributes: + label: Describe the bug. + description: 'A clear and concise description of what the bug is.' + - type: textarea + attributes: + label: Describe the steps to reproduce the behavior. + description: 'Be clear and concise while describing the steps to ensure that it can be reproduced and potentially fixed' + - type: textarea + attributes: + label: Expected behavior. + description: 'A clear and concise description of what you expected to happen.' + - type: textarea + attributes: + label: Screenshots. + description: 'If applicable, add screenshots to help explain your problem.' + - type: input + attributes: + label: Operating Environment + description: 'What operating system and version are you using? If you are running it on Cloud/Cluster do mention about that.' + validations: + required: true + - type: textarea + attributes: + label: Additional Information + description: 'Any additional information that may help us reproduce the bug.' + diff --git a/.github/ISSUE_TEMPLATE/documentation-update.yml b/.github/ISSUE_TEMPLATE/documentation-update.yml new file mode 100644 index 00000000..7fcc4ec4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-update.yml @@ -0,0 +1,29 @@ +name: Documentation Update +description: Suggest how we can improve our documentation +title: "Documentation: " +labels: [documentation] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Documentation update report. + - type: textarea + attributes: + label: What is the current documentation state? + description: 'Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original.' + - type: textarea + attributes: + label: Where is this stated? + description: 'Provide additional information about the location where you have copied the above statement from.' + - type: textarea + attributes: + label: Why do you want to improve the statement? + description: 'Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc.' + - type: textarea + attributes: + label: Proposed Statement + description: 'Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request.' + - type: textarea + attributes: + label: Additional context. + description: 'Add any other context or useful information about the documentation update here.' diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..839a2ac1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,25 @@ +name: Feature Request +description: Suggest an idea for this project +title: "Feature Request: " +labels: [enhancement] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Feature Request report. + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: 'A clear and concise description of what the problem is. Ex. I am always frustrated when [...]' + - type: textarea + attributes: + label: Describe the solution you'd like. + description: 'A clear and concise description of what you want to happen.' + - type: textarea + attributes: + label: Describe alternatives you've considered + description: 'A clear and concise description of any alternative solutions or features you have considered.' + - type: textarea + attributes: + label: Additional context. + description: 'Add any other context or screenshots about the feature request here.' diff --git a/.github/ISSUE_TEMPLATE/user-feedback.yml b/.github/ISSUE_TEMPLATE/user-feedback.yml new file mode 100644 index 00000000..cee6576e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user-feedback.yml @@ -0,0 +1,25 @@ +name: User Feedback +description: Describe how we can improve your experience +title: "User Feedback: " +labels: [user-feedback] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a User Feedback report. + - type: textarea + attributes: + label: Describe what you are trying to do and why it is not optimal. + description: 'A clear and concise description of what the problem is. Ex. When I reach this point, I cannot [...]' + - type: textarea + attributes: + label: Describe the solution you'd like. + description: 'A clear and concise description of what you want to happen.' + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: 'A clear and concise description of any alternative solutions or features you have considered.' + - type: textarea + attributes: + label: Additional context. + description: 'Add any other context or screenshots about the feature request here.'