From 167aa971b52ca54f5f121ee3b628b7a1b2327ac2 Mon Sep 17 00:00:00 2001 From: C3Suryansu Date: Mon, 11 Oct 2021 23:51:21 +0530 Subject: [PATCH] Added template file --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/custom-issue.md | 13 +++++++ .github/ISSUE_TEMPLATE/documentation-error.md | 13 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ .github/pull_request_template.md | 27 +++++++++++++ 5 files changed, 111 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/custom-issue.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-error.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**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/custom-issue.md b/.github/ISSUE_TEMPLATE/custom-issue.md new file mode 100644 index 0000000..21101cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom-issue.md @@ -0,0 +1,13 @@ +--- +name: Custom Issue +about: Raise your own custom issue +title: '' +labels: '' +assignees: '' + +--- + +Describe the issue: **Describe your issue here** +How to reproduce the issue: **Describe how to reproduce the issue** +Expected behavior: **What is the behavior expected** +Proof of issue(Screenshot/Location where to find the issue): **Mention where to find the issue, also attach proof of issues is available** diff --git a/.github/ISSUE_TEMPLATE/documentation-error.md b/.github/ISSUE_TEMPLATE/documentation-error.md new file mode 100644 index 0000000..018efe3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-error.md @@ -0,0 +1,13 @@ +--- +name: Documentation error +about: Raise an issue related to Documentation +title: '' +labels: '' +assignees: '' + +--- + +Describe the issue: **Describe your issue here** +How to reproduce the issue: **Describe how to reproduce the issue** +Expected behavior: **What is the behavior expected** +Proof of issue(Screenshot/Location where to find the issue): **Mention where to find the issue, also attach proof of issues is available** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**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/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7492fd6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +INCLUDE ALL NECESSARY FIELDS AND DELETE FIELDS THAT ARE NOT NECESSARY. + +### Description +Include a summary of the change and relevant motivation/context. List any dependencies that are required for this change. + +Fixes # [ISSUE] + +### Type of Change: +**Delete irrelevant options.** + +- Code +- Quality Assurance +- User Interface +- Outreach +- Documentation + +**Code/Quality Assurance Only** +- Bug fix (non-breaking change which fixes an issue) +- This change requires a documentation update (software upgrade on readme file) +- New feature (non-breaking change which adds functionality pre-approved by mentors) + + + +### How Has This Been Tested? +Describe the tests you ran to verify your changes. Provide instructions or GIFs so we can reproduce. List any relevant details for your test. + +