From 040a22cd54c324024ee8046097db8b66e3d2fafe Mon Sep 17 00:00:00 2001 From: Padmaja Bhol <75530516+padmajabhol@users.noreply.github.com> Date: Sat, 29 Jan 2022 11:22:36 +0530 Subject: [PATCH] Change YAML files to markdown --- .github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 35 ---------------- .../ISSUE_TEMPLATE/documentation_update.md | 24 +++++++++++ .../ISSUE_TEMPLATE/documentation_update.yml | 29 ------------- .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 25 ----------- 6 files changed, 87 insertions(+), 89 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_update.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation_update.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9365291 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +Thank you for taking the time to file a Bug report. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] + +**Smartphone (please complete the following information):** + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index e0d37eb..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,35 +0,0 @@ -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.md b/.github/ISSUE_TEMPLATE/documentation_update.md new file mode 100644 index 0000000..27b20fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.md @@ -0,0 +1,24 @@ +--- +name: Documentation Update +about: Suggest how we can improve our documentation +title: '' +labels: '' +assignees: '' +--- + +Thank you for taking the time to file a Documentation Update report. + +**What is the current documentation state?** +Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original. + +**Where is this stated?** +Provide additional information about the location where you have copied the above statement from. + +**Why do you want to improve the statement?** +Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc. + +**Proposed Statement** +Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request. + +**Additional context.** +Add any other context or useful information about the documentation update here. diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yml b/.github/ISSUE_TEMPLATE/documentation_update.yml deleted file mode 100644 index 3864ebd..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_update.yml +++ /dev/null @@ -1,29 +0,0 @@ -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.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..84f02b3 --- /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: '' +assignees: '' +--- + +Thank you for taking the time to file a Feature Request report. + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index e88b47b..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,25 +0,0 @@ -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.'